picked 0.0.101 → 0.0.102-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/reference/dashboard/workflow-test-runs.md +40 -17
- package/docs/reference/management-api/schema/action.md +67 -79
- package/docs/reference/management-api/schema/analytics-session.md +77 -94
- package/docs/reference/management-api/schema/analytics.md +16 -14
- package/docs/reference/management-api/schema/api-key.md +43 -51
- package/docs/reference/management-api/schema/auth.md +271 -404
- package/docs/reference/management-api/schema/cms-fields.md +348 -245
- package/docs/reference/management-api/schema/cms-models.md +369 -378
- package/docs/reference/management-api/schema/common.md +69 -130
- package/docs/reference/management-api/schema/condition.md +63 -74
- package/docs/reference/management-api/schema/design-system.md +59 -51
- package/docs/reference/management-api/schema/experience.md +388 -364
- package/docs/reference/management-api/schema/external-api.md +153 -171
- package/docs/reference/management-api/schema/feature.md +85 -103
- package/docs/reference/management-api/schema/feedback.md +27 -31
- package/docs/reference/management-api/schema/field.md +117 -135
- package/docs/reference/management-api/schema/index.md +184 -184
- package/docs/reference/management-api/schema/integration.md +72 -78
- package/docs/reference/management-api/schema/label.md +81 -137
- package/docs/reference/management-api/schema/lead.md +80 -119
- package/docs/reference/management-api/schema/mcp-server.md +73 -71
- package/docs/reference/management-api/schema/metric.md +6 -9
- package/docs/reference/management-api/schema/operation.md +17 -26
- package/docs/reference/management-api/schema/organization.md +198 -220
- package/docs/reference/management-api/schema/project.md +177 -186
- package/docs/reference/management-api/schema/report.md +69 -65
- package/docs/reference/management-api/schema/saved-view.md +71 -71
- package/docs/reference/management-api/schema/shopify.md +331 -204
- package/docs/reference/management-api/schema/step.md +72 -80
- package/docs/reference/management-api/schema/tenant-branding.md +48 -70
- package/docs/reference/management-api/schema/workbench.md +54 -66
- package/docs/reference/management-api/schema/workflow-run.md +66 -79
- package/docs/reference/management-api/schema/workflow.md +310 -353
- package/docs/reference/management-api/schema/workspace-version.md +212 -261
- package/docs/reference/management-api/schema/workspace.md +275 -328
- package/package.json +4 -4
|
@@ -21,190 +21,190 @@ An operation with `@auth` needs a caller that has authenticated. `@auth(only: US
|
|
|
21
21
|
|
|
22
22
|
| Operation | Type | Description |
|
|
23
23
|
| --- | --- | --- |
|
|
24
|
-
| [`accountCreate`](/reference/management-api/schema/auth#accountcreate) | Mutation |
|
|
25
|
-
| [`accountResendVerification`](/reference/management-api/schema/auth#accountresendverification) | Mutation |
|
|
26
|
-
| [`accountVerifyEmail`](/reference/management-api/schema/auth#accountverifyemail) | Mutation |
|
|
27
|
-
| [`action`](/reference/management-api/schema/action#action) | Query |
|
|
28
|
-
| [`actionCreate`](/reference/management-api/schema/action#actioncreate) | Mutation |
|
|
29
|
-
| [`actionDelete`](/reference/management-api/schema/action#actiondelete) | Mutation |
|
|
30
|
-
| [`actions`](/reference/management-api/schema/action#actions) | Query |
|
|
31
|
-
| [`actionUpdate`](/reference/management-api/schema/action#actionupdate) | Mutation |
|
|
32
|
-
| [`apiKeyCreate`](/reference/management-api/schema/api-key#apikeycreate) | Mutation |
|
|
33
|
-
| [`apiKeyRevoke`](/reference/management-api/schema/api-key#apikeyrevoke) | Mutation |
|
|
34
|
-
| [`apiKeys`](/reference/management-api/schema/api-key#apikeys) | Query |
|
|
35
|
-
| [`asset`](/reference/management-api/schema/cms-models#asset) | Query |
|
|
36
|
-
| [`assetCommit`](/reference/management-api/schema/cms-models#assetcommit) | Mutation |
|
|
37
|
-
| [`assetDelete`](/reference/management-api/schema/cms-models#assetdelete) | Mutation |
|
|
38
|
-
| [`assets`](/reference/management-api/schema/cms-models#assets) | Query |
|
|
39
|
-
| [`assetUploadInit`](/reference/management-api/schema/cms-models#assetuploadinit) | Mutation |
|
|
40
|
-
| [`condition`](/reference/management-api/schema/condition#condition) | Query |
|
|
41
|
-
| [`conditionCreate`](/reference/management-api/schema/condition#conditioncreate) | Mutation |
|
|
42
|
-
| [`conditionDelete`](/reference/management-api/schema/condition#conditiondelete) | Mutation |
|
|
43
|
-
| [`conditions`](/reference/management-api/schema/condition#conditions) | Query |
|
|
44
|
-
| [`conditionUpdate`](/reference/management-api/schema/condition#conditionupdate) | Mutation |
|
|
45
|
-
| [`contentBlock`](/reference/management-api/schema/cms-models#contentblock) | Query |
|
|
46
|
-
| [`contentBlockCreate`](/reference/management-api/schema/cms-models#contentblockcreate) | Mutation |
|
|
47
|
-
| [`contentBlockDelete`](/reference/management-api/schema/cms-models#contentblockdelete) | Mutation |
|
|
48
|
-
| [`contentBlocks`](/reference/management-api/schema/cms-models#contentblocks) | Query |
|
|
49
|
-
| [`contentBlockUpdate`](/reference/management-api/schema/cms-models#contentblockupdate) | Mutation |
|
|
50
|
-
| [`contentEntries`](/reference/management-api/schema/cms-models#contententries) | Query |
|
|
51
|
-
| [`contentEntry`](/reference/management-api/schema/cms-models#contententry) | Query |
|
|
52
|
-
| [`contentEntryCreate`](/reference/management-api/schema/cms-models#contententrycreate) | Mutation |
|
|
53
|
-
| [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | Mutation |
|
|
54
|
-
| [`contentEntryUpdate`](/reference/management-api/schema/cms-models#contententryupdate) | Mutation |
|
|
55
|
-
| [`contentModel`](/reference/management-api/schema/cms-models#contentmodel) | Query |
|
|
56
|
-
| [`contentModelCreate`](/reference/management-api/schema/cms-models#contentmodelcreate) | Mutation |
|
|
57
|
-
| [`contentModelDelete`](/reference/management-api/schema/cms-models#contentmodeldelete) | Mutation |
|
|
58
|
-
| [`contentModels`](/reference/management-api/schema/cms-models#contentmodels) | Query |
|
|
59
|
-
| [`contentModelUpdate`](/reference/management-api/schema/cms-models#contentmodelupdate) | Mutation |
|
|
60
|
-
| [`createShopifyMetafieldConfig`](/reference/management-api/schema/shopify#createshopifymetafieldconfig) | Mutation |
|
|
61
|
-
| [`createShopifyWebhook`](/reference/management-api/schema/shopify#createshopifywebhook) | Mutation |
|
|
62
|
-
| [`deleteShopifyMetafieldConfig`](/reference/management-api/schema/shopify#deleteshopifymetafieldconfig) | Mutation |
|
|
63
|
-
| [`deleteShopifyWebhook`](/reference/management-api/schema/shopify#deleteshopifywebhook) | Mutation |
|
|
64
|
-
| [`designSystem`](/reference/management-api/schema/design-system#designsystem) | Query |
|
|
65
|
-
| [`designSystemCreate`](/reference/management-api/schema/design-system#designsystemcreate) | Mutation |
|
|
66
|
-
| [`designSystemDelete`](/reference/management-api/schema/design-system#designsystemdelete) | Mutation |
|
|
67
|
-
| [`designSystems`](/reference/management-api/schema/design-system#designsystems) | Query |
|
|
68
|
-
| [`designSystemUpdate`](/reference/management-api/schema/design-system#designsystemupdate) | Mutation |
|
|
69
|
-
| [`emailLinkVerify`](/reference/management-api/schema/auth#emaillinkverify) | Mutation |
|
|
70
|
-
| [`experience`](/reference/management-api/schema/experience#experience) | Query |
|
|
71
|
-
| [`experienceCreate`](/reference/management-api/schema/experience#experiencecreate) | Mutation |
|
|
72
|
-
| [`experienceDelete`](/reference/management-api/schema/experience#experiencedelete) | Mutation |
|
|
73
|
-
| [`experienceFlowUpdate`](/reference/management-api/schema/experience#experienceflowupdate) | Mutation |
|
|
74
|
-
| [`experiences`](/reference/management-api/schema/experience#experiences) | Query |
|
|
75
|
-
| [`experienceUpdate`](/reference/management-api/schema/experience#experienceupdate) | Mutation |
|
|
76
|
-
| [`externalApi`](/reference/management-api/schema/external-api#externalapi) | Query |
|
|
77
|
-
| [`externalApiAuthHeaderClear`](/reference/management-api/schema/external-api#externalapiauthheaderclear) | Mutation |
|
|
78
|
-
| [`externalApiAuthHeaderSet`](/reference/management-api/schema/external-api#externalapiauthheaderset) | Mutation |
|
|
79
|
-
| [`externalApiCreate`](/reference/management-api/schema/external-api#externalapicreate) | Mutation |
|
|
80
|
-
| [`externalApiDelete`](/reference/management-api/schema/external-api#externalapidelete) | Mutation |
|
|
81
|
-
| [`externalApiOAuth2Clear`](/reference/management-api/schema/external-api#externalapioauth2clear) | Mutation |
|
|
82
|
-
| [`externalApiOAuth2Set`](/reference/management-api/schema/external-api#externalapioauth2set) | Mutation |
|
|
83
|
-
| [`externalApiUpdate`](/reference/management-api/schema/external-api#externalapiupdate) | Mutation |
|
|
84
|
-
| [`feature`](/reference/management-api/schema/feature#feature) | Query |
|
|
85
|
-
| [`featureCreate`](/reference/management-api/schema/feature#featurecreate) | Mutation |
|
|
86
|
-
| [`featureDelete`](/reference/management-api/schema/feature#featuredelete) | Mutation |
|
|
87
|
-
| [`features`](/reference/management-api/schema/feature#features) | Query |
|
|
88
|
-
| [`featureUpdate`](/reference/management-api/schema/feature#featureupdate) | Mutation |
|
|
89
|
-
| [`feedbackCreate`](/reference/management-api/schema/feedback#feedbackcreate) | Mutation |
|
|
90
|
-
| [`field`](/reference/management-api/schema/field#field) | Query |
|
|
91
|
-
| [`fieldCreate`](/reference/management-api/schema/field#fieldcreate) | Mutation |
|
|
92
|
-
| [`fieldDelete`](/reference/management-api/schema/field#fielddelete) | Mutation |
|
|
93
|
-
| [`fields`](/reference/management-api/schema/field#fields) | Query |
|
|
94
|
-
| [`fieldUpdate`](/reference/management-api/schema/field#fieldupdate) | Mutation |
|
|
95
|
-
| [`integrationConfigurationCreate`](/reference/management-api/schema/integration#integrationconfigurationcreate) | Mutation |
|
|
96
|
-
| [`integrationConfigurationDelete`](/reference/management-api/schema/integration#integrationconfigurationdelete) | Mutation |
|
|
97
|
-
| [`integrationConfigurationUpdate`](/reference/management-api/schema/integration#integrationconfigurationupdate) | Mutation |
|
|
98
|
-
| [`integrationInstall`](/reference/management-api/schema/integration#integrationinstall) | Mutation |
|
|
99
|
-
| [`integrationUninstall`](/reference/management-api/schema/integration#integrationuninstall) | Mutation |
|
|
100
|
-
| [`labelsDelete`](/reference/management-api/schema/label#labelsdelete) | Mutation |
|
|
101
|
-
| [`labelsSet`](/reference/management-api/schema/label#labelsset) | Mutation |
|
|
102
|
-
| [`lead`](/reference/management-api/schema/lead#lead) | Query |
|
|
103
|
-
| [`leadDelete`](/reference/management-api/schema/lead#leaddelete) | Mutation |
|
|
104
|
-
| [`magicLinkSend`](/reference/management-api/schema/auth#magiclinksend) | Mutation |
|
|
105
|
-
| [`magicLinkVerify`](/reference/management-api/schema/auth#magiclinkverify) | Mutation |
|
|
106
|
-
| [`mcpServer`](/reference/management-api/schema/mcp-server#mcpserver) | Query |
|
|
107
|
-
| [`mcpServerAuthHeaderClear`](/reference/management-api/schema/mcp-server#mcpserverauthheaderclear) | Mutation |
|
|
108
|
-
| [`mcpServerAuthHeaderSet`](/reference/management-api/schema/mcp-server#mcpserverauthheaderset) | Mutation |
|
|
109
|
-
| [`mcpServerDelete`](/reference/management-api/schema/mcp-server#mcpserverdelete) | Mutation |
|
|
110
|
-
| [`mcpServerRegister`](/reference/management-api/schema/mcp-server#mcpserverregister) | Mutation |
|
|
111
|
-
| [`mcpServerUpdate`](/reference/management-api/schema/mcp-server#mcpserverupdate) | Mutation |
|
|
112
|
-
| [`mcpServerUrlSet`](/reference/management-api/schema/mcp-server#mcpserverurlset) | Mutation |
|
|
113
|
-
| [`mfaChallengeCreate`](/reference/management-api/schema/auth#mfachallengecreate) | Mutation |
|
|
114
|
-
| [`mfaChallengeVerify`](/reference/management-api/schema/auth#mfachallengeverify) | Mutation |
|
|
115
|
-
| [`mfaFactorEnroll`](/reference/management-api/schema/auth#mfafactorenroll) | Mutation |
|
|
116
|
-
| [`mfaFactorUnenroll`](/reference/management-api/schema/auth#mfafactorunenroll) | Mutation |
|
|
117
|
-
| [`oauthAuthorize`](/reference/management-api/schema/auth#oauthauthorize) | Mutation |
|
|
118
|
-
| [`oauthCallback`](/reference/management-api/schema/auth#oauthcallback) | Mutation |
|
|
119
|
-
| [`oauthConsentApprove`](/reference/management-api/schema/auth#oauthconsentapprove) | Mutation |
|
|
120
|
-
| [`oauthConsentDeny`](/reference/management-api/schema/auth#oauthconsentdeny) | Mutation |
|
|
121
|
-
| [`oauthConsentDetails`](/reference/management-api/schema/auth#oauthconsentdetails) | Query |
|
|
122
|
-
| [`organization`](/reference/management-api/schema/organization#organization) | Query |
|
|
123
|
-
| [`organizationClientManagerScopesUpdate`](/reference/management-api/schema/organization#organizationclientmanagerscopesupdate) | Mutation |
|
|
124
|
-
| [`organizationCreate`](/reference/management-api/schema/organization#organizationcreate) | Mutation |
|
|
125
|
-
| [`organizationDelete`](/reference/management-api/schema/organization#organizationdelete) | Mutation |
|
|
126
|
-
| [`organizationInvitationAccept`](/reference/management-api/schema/organization#organizationinvitationaccept) | Mutation |
|
|
127
|
-
| [`organizationInvitationDecline`](/reference/management-api/schema/organization#organizationinvitationdecline) | Mutation |
|
|
128
|
-
| [`organizationInvitationRevoke`](/reference/management-api/schema/organization#organizationinvitationrevoke) | Mutation |
|
|
129
|
-
| [`organizationMemberInvite`](/reference/management-api/schema/organization#organizationmemberinvite) | Mutation |
|
|
130
|
-
| [`organizationMemberRemove`](/reference/management-api/schema/organization#organizationmemberremove) | Mutation |
|
|
131
|
-
| [`organizationMemberScopesUpdate`](/reference/management-api/schema/organization#organizationmemberscopesupdate) | Mutation |
|
|
132
|
-
| [`organizations`](/reference/management-api/schema/organization#organizations) | Query |
|
|
133
|
-
| [`organizationShopifyWebhooks`](/reference/management-api/schema/shopify#organizationshopifywebhooks) | Query |
|
|
134
|
-
| [`organizationUpdate`](/reference/management-api/schema/organization#organizationupdate) | Mutation |
|
|
135
|
-
| [`passwordResetSend`](/reference/management-api/schema/auth#passwordresetsend) | Mutation |
|
|
136
|
-
| [`passwordUpdate`](/reference/management-api/schema/auth#passwordupdate) | Mutation |
|
|
137
|
-
| [`pickedqlQuery`](/reference/management-api/schema/analytics#pickedqlquery) | Query |
|
|
138
|
-
| [`ping`](/reference/management-api/schema/common#ping) | Query |
|
|
139
|
-
| [`project`](/reference/management-api/schema/project#project) | Query |
|
|
140
|
-
| [`projectCreate`](/reference/management-api/schema/project#projectcreate) | Mutation |
|
|
141
|
-
| [`projectDelete`](/reference/management-api/schema/project#projectdelete) | Mutation |
|
|
142
|
-
| [`projectPreviewEnvironmentCreate`](/reference/management-api/schema/project#projectpreviewenvironmentcreate) | Mutation |
|
|
143
|
-
| [`projectPreviewEnvironmentDelete`](/reference/management-api/schema/project#projectpreviewenvironmentdelete) | Mutation |
|
|
144
|
-
| [`projectPreviewEnvironmentUpdate`](/reference/management-api/schema/project#projectpreviewenvironmentupdate) | Mutation |
|
|
145
|
-
| [`projects`](/reference/management-api/schema/project#projects) | Query |
|
|
146
|
-
| [`projectShopifyMetafieldConfigs`](/reference/management-api/schema/shopify#projectshopifymetafieldconfigs) | Query |
|
|
147
|
-
| [`projectUpdate`](/reference/management-api/schema/project#projectupdate) | Mutation |
|
|
148
|
-
| [`report`](/reference/management-api/schema/report#report) | Query |
|
|
149
|
-
| [`reportCreate`](/reference/management-api/schema/report#reportcreate) | Mutation |
|
|
150
|
-
| [`reportDelete`](/reference/management-api/schema/report#reportdelete) | Mutation |
|
|
151
|
-
| [`reportUpdate`](/reference/management-api/schema/report#reportupdate) | Mutation |
|
|
152
|
-
| [`savedView`](/reference/management-api/schema/saved-view#savedview) | Query |
|
|
153
|
-
| [`savedViewCreate`](/reference/management-api/schema/saved-view#savedviewcreate) | Mutation |
|
|
154
|
-
| [`savedViewDelete`](/reference/management-api/schema/saved-view#savedviewdelete) | Mutation |
|
|
155
|
-
| [`savedViewUpdate`](/reference/management-api/schema/saved-view#savedviewupdate) | Mutation |
|
|
156
|
-
| [`sessionCreate`](/reference/management-api/schema/auth#sessioncreate) | Mutation |
|
|
157
|
-
| [`sessionRefresh`](/reference/management-api/schema/auth#sessionrefresh) | Mutation |
|
|
158
|
-
| [`sessionStart`](/reference/management-api/schema/auth#sessionstart) | Mutation |
|
|
159
|
-
| [`shopifyCollectionContentUpdate`](/reference/management-api/schema/shopify#shopifycollectioncontentupdate) | Mutation |
|
|
160
|
-
| [`shopifyMetafieldConfigCreate`](/reference/management-api/schema/shopify#shopifymetafieldconfigcreate) | Mutation |
|
|
161
|
-
| [`shopifyMetafieldConfigDelete`](/reference/management-api/schema/shopify#shopifymetafieldconfigdelete) | Mutation |
|
|
162
|
-
| [`shopifyMetafieldConfigs`](/reference/management-api/schema/shopify#shopifymetafieldconfigs) | Query |
|
|
163
|
-
| [`shopifyMetafieldConfigUpdate`](/reference/management-api/schema/shopify#shopifymetafieldconfigupdate) | Mutation |
|
|
164
|
-
| [`shopifyProduct`](/reference/management-api/schema/shopify#shopifyproduct) | Query |
|
|
165
|
-
| [`shopifyProductContentUpdate`](/reference/management-api/schema/shopify#shopifyproductcontentupdate) | Mutation |
|
|
166
|
-
| [`shopifyProducts`](/reference/management-api/schema/shopify#shopifyproducts) | Query |
|
|
167
|
-
| [`shopifyWebhookCreate`](/reference/management-api/schema/shopify#shopifywebhookcreate) | Mutation |
|
|
168
|
-
| [`shopifyWebhookDelete`](/reference/management-api/schema/shopify#shopifywebhookdelete) | Mutation |
|
|
169
|
-
| [`shopifyWebhooks`](/reference/management-api/schema/shopify#shopifywebhooks) | Query |
|
|
170
|
-
| [`shopifyWebhookUpdate`](/reference/management-api/schema/shopify#shopifywebhookupdate) | Mutation |
|
|
171
|
-
| [`step`](/reference/management-api/schema/step#step) | Query |
|
|
172
|
-
| [`stepCreate`](/reference/management-api/schema/step#stepcreate) | Mutation |
|
|
173
|
-
| [`stepDelete`](/reference/management-api/schema/step#stepdelete) | Mutation |
|
|
174
|
-
| [`steps`](/reference/management-api/schema/step#steps) | Query |
|
|
175
|
-
| [`stepUpdate`](/reference/management-api/schema/step#stepupdate) | Mutation |
|
|
176
|
-
| [`tenant`](/reference/management-api/schema/tenant-branding#tenant) | Query |
|
|
177
|
-
| [`updateShopifyCollectionContent`](/reference/management-api/schema/shopify#updateshopifycollectioncontent) | Mutation |
|
|
178
|
-
| [`updateShopifyMetafieldConfig`](/reference/management-api/schema/shopify#updateshopifymetafieldconfig) | Mutation |
|
|
179
|
-
| [`updateShopifyProductContent`](/reference/management-api/schema/shopify#updateshopifyproductcontent) | Mutation |
|
|
180
|
-
| [`updateShopifyWebhook`](/reference/management-api/schema/shopify#updateshopifywebhook) | Mutation |
|
|
181
|
-
| [`user`](/reference/management-api/schema/auth#user) | Query |
|
|
182
|
-
| [`viewerScopes`](/reference/management-api/schema/auth#viewerscopes) | Query |
|
|
183
|
-
| [`workbenchAssetAdoptOwned`](/reference/management-api/schema/workbench#workbenchassetadoptowned) | Mutation |
|
|
184
|
-
| [`workbenchAssetImport`](/reference/management-api/schema/workbench#workbenchassetimport) | Mutation | Imports an
|
|
185
|
-
| [`workbenchAssetRemove`](/reference/management-api/schema/workbench#workbenchassetremove) | Mutation | Removes an
|
|
186
|
-
| [`workflow`](/reference/management-api/schema/workflow#workflow) | Query |
|
|
187
|
-
| [`workflowCreate`](/reference/management-api/schema/workflow#workflowcreate) | Mutation |
|
|
188
|
-
| [`workflowDelete`](/reference/management-api/schema/workflow#workflowdelete) | Mutation |
|
|
189
|
-
| [`workflowGraphUpdate`](/reference/management-api/schema/workflow#workflowgraphupdate) | Mutation |
|
|
190
|
-
| [`workflowRun`](/reference/management-api/schema/workflow-run#workflowrun) | Query |
|
|
191
|
-
| [`workflows`](/reference/management-api/schema/workflow#workflows) | Query |
|
|
192
|
-
| [`workflowTestRun`](/reference/management-api/schema/workflow#workflowtestrun) | Mutation |
|
|
193
|
-
| [`workflowTools`](/reference/management-api/schema/workflow#workflowtools) | Query |
|
|
194
|
-
| [`workflowUpdate`](/reference/management-api/schema/workflow#workflowupdate) | Mutation |
|
|
195
|
-
| [`workspace`](/reference/management-api/schema/workspace#workspace) | Query |
|
|
196
|
-
| [`workspaceArchive`](/reference/management-api/schema/workspace#workspacearchive) | Mutation |
|
|
197
|
-
| [`workspaceContentEntryValidation`](/reference/management-api/schema/cms-models#workspacecontententryvalidation) | Query |
|
|
198
|
-
| [`workspaceCreate`](/reference/management-api/schema/workspace#workspacecreate) | Mutation |
|
|
199
|
-
| [`workspaceDelete`](/reference/management-api/schema/workspace#workspacedelete) | Mutation |
|
|
200
|
-
| [`workspaceDiff`](/reference/management-api/schema/workspace-version#workspacediff) | Query |
|
|
201
|
-
| [`workspaceDuplicate`](/reference/management-api/schema/workspace#workspaceduplicate) | Mutation |
|
|
202
|
-
| [`workspaceExport`](/reference/management-api/schema/workspace#workspaceexport) | Query |
|
|
203
|
-
| [`workspaceImport`](/reference/management-api/schema/workspace#workspaceimport) | Mutation |
|
|
204
|
-
| [`workspacePublish`](/reference/management-api/schema/workspace#workspacepublish) | Mutation |
|
|
205
|
-
| [`workspaceUnarchive`](/reference/management-api/schema/workspace#workspaceunarchive) | Mutation |
|
|
206
|
-
| [`workspaceUpdate`](/reference/management-api/schema/workspace#workspaceupdate) | Mutation |
|
|
207
|
-
| [`workspaceVersionPublish`](/reference/management-api/schema/workspace#workspaceversionpublish) | Mutation |
|
|
24
|
+
| [`accountCreate`](/reference/management-api/schema/auth#accountcreate) | Mutation | Registers an email address and emails it a confirmation code and link. The response does not reveal whether the address has an account. Returns `RATE_LIMITED` when the project's email quota is spent. |
|
|
25
|
+
| [`accountResendVerification`](/reference/management-api/schema/auth#accountresendverification) | Mutation | Emails an existing account a new code and link: a confirmation, or a sign-in for a confirmed account. An address with no account returns an error, so the response reveals whether an account exists. An address emailed within the minimum send interval returns `RATE_LIMITED`. |
|
|
26
|
+
| [`accountVerifyEmail`](/reference/management-api/schema/auth#accountverifyemail) | Mutation | Verifies the six-digit code from a confirmation or sign-in email and creates a session. |
|
|
27
|
+
| [`action`](/reference/management-api/schema/action#action) | Query | Reads an action. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
28
|
+
| [`actionCreate`](/reference/management-api/schema/action#actioncreate) | Mutation | Creates an action in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
29
|
+
| [`actionDelete`](/reference/management-api/schema/action#actiondelete) | Mutation | Deletes an action and the workflow it starts. An action that an experience references is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
30
|
+
| [`actions`](/reference/management-api/schema/action#actions) | Query | Lists the actions in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
31
|
+
| [`actionUpdate`](/reference/management-api/schema/action#actionupdate) | Mutation | Updates an action. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
32
|
+
| [`apiKeyCreate`](/reference/management-api/schema/api-key#apikeycreate) | Mutation | Creates an API key and returns the full key, once. A blank name, no scopes, or a scope the caller does not hold or the key cannot carry returns `VALIDATION_ERROR`. Scope: `ORGANIZATION_API_KEYS_CREATE`. |
|
|
33
|
+
| [`apiKeyRevoke`](/reference/management-api/schema/api-key#apikeyrevoke) | Mutation | Revokes an API key, which then stops authenticating at once. Cannot be undone; an unknown or revoked key returns `NOT_FOUND`. Scope: `ORGANIZATION_API_KEYS_DELETE`. |
|
|
34
|
+
| [`apiKeys`](/reference/management-api/schema/api-key#apikeys) | Query | Lists an organisation's API keys, newest first. Revoked keys are left out. Scope: `ORGANIZATION_API_KEYS_READ`. |
|
|
35
|
+
| [`asset`](/reference/management-api/schema/cms-models#asset) | Query | Reads an asset. Scope: `ORGANIZATION_PROJECTS_READ`. |
|
|
36
|
+
| [`assetCommit`](/reference/management-api/schema/cms-models#assetcommit) | Mutation | Commits an uploaded file as the asset's current version, recording its size, MIME type and image dimensions. Fails when the bytes do not match the claimed content type. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
37
|
+
| [`assetDelete`](/reference/management-api/schema/cms-models#assetdelete) | Mutation | Deletes an asset and its stored files. Fails with `CONFLICT` once a publish uses any of its versions; content entries that reference it are not checked. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
38
|
+
| [`assets`](/reference/management-api/schema/cms-models#assets) | Query | Lists the assets in a project, newest first by default. Scope: `ORGANIZATION_PROJECTS_READ`. |
|
|
39
|
+
| [`assetUploadInit`](/reference/management-api/schema/cms-models#assetuploadinit) | Mutation | Starts an asset upload and returns a pre-signed URL to PUT the bytes to. Nothing is stored until `assetCommit`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
40
|
+
| [`condition`](/reference/management-api/schema/condition#condition) | Query | Reads a condition. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
41
|
+
| [`conditionCreate`](/reference/management-api/schema/condition#conditioncreate) | Mutation | Creates a condition in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
42
|
+
| [`conditionDelete`](/reference/management-api/schema/condition#conditiondelete) | Mutation | Deletes a condition. A condition that an experience or another condition references is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
43
|
+
| [`conditions`](/reference/management-api/schema/condition#conditions) | Query | Lists the conditions in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
44
|
+
| [`conditionUpdate`](/reference/management-api/schema/condition#conditionupdate) | Mutation | Updates a condition. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
45
|
+
| [`contentBlock`](/reference/management-api/schema/cms-models#contentblock) | Query | Reads a block. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
46
|
+
| [`contentBlockCreate`](/reference/management-api/schema/cms-models#contentblockcreate) | Mutation | Creates a block. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
47
|
+
| [`contentBlockDelete`](/reference/management-api/schema/cms-models#contentblockdelete) | Mutation | Deletes a block. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
48
|
+
| [`contentBlocks`](/reference/management-api/schema/cms-models#contentblocks) | Query | Lists the blocks in a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
49
|
+
| [`contentBlockUpdate`](/reference/management-api/schema/cms-models#contentblockupdate) | Mutation | Updates a block. A schema change does not migrate the content entries that embed it. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
50
|
+
| [`contentEntries`](/reference/management-api/schema/cms-models#contententries) | Query | Lists the content entries in a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
51
|
+
| [`contentEntry`](/reference/management-api/schema/cms-models#contententry) | Query | Reads a content entry. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
52
|
+
| [`contentEntryCreate`](/reference/management-api/schema/cms-models#contententrycreate) | Mutation | Creates a content entry of a model. Each asset reference without a version is pinned to the asset's current version. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
53
|
+
| [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | Mutation | Deletes a content entry. Fails with `CONFLICT` while a step uses it as its layout, or while another content entry references it. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
54
|
+
| [`contentEntryUpdate`](/reference/management-api/schema/cms-models#contententryupdate) | Mutation | Updates the data of a content entry. Each asset reference without a version is pinned to the asset's current version. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
55
|
+
| [`contentModel`](/reference/management-api/schema/cms-models#contentmodel) | Query | Reads a model. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
56
|
+
| [`contentModelCreate`](/reference/management-api/schema/cms-models#contentmodelcreate) | Mutation | Creates a model. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
57
|
+
| [`contentModelDelete`](/reference/management-api/schema/cms-models#contentmodeldelete) | Mutation | Deletes a model. Fails with `CONFLICT` while content entries use it, or while another schema's reference field targets it. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
58
|
+
| [`contentModels`](/reference/management-api/schema/cms-models#contentmodels) | Query | Lists the models in a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
59
|
+
| [`contentModelUpdate`](/reference/management-api/schema/cms-models#contentmodelupdate) | Mutation | Updates a model. A schema change migrates the data of its content entries and lists each removed value in `migrationWarnings`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
60
|
+
| [`createShopifyMetafieldConfig`](/reference/management-api/schema/shopify#createshopifymetafieldconfig) | Mutation | Creates a Shopify metafield config for a project. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
|
|
61
|
+
| [`createShopifyWebhook`](/reference/management-api/schema/shopify#createshopifywebhook) | Mutation | Creates a Shopify webhook for a project and generates its HMAC secret. The result is the only place the secret appears. Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
62
|
+
| [`deleteShopifyMetafieldConfig`](/reference/management-api/schema/shopify#deleteshopifymetafieldconfig) | Mutation | Deletes a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
63
|
+
| [`deleteShopifyWebhook`](/reference/management-api/schema/shopify#deleteshopifywebhook) | Mutation | Deletes a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
64
|
+
| [`designSystem`](/reference/management-api/schema/design-system#designsystem) | Query | Reads a design system. Scope: `ORGANIZATION_PROJECTS_READ`. |
|
|
65
|
+
| [`designSystemCreate`](/reference/management-api/schema/design-system#designsystemcreate) | Mutation | Creates a design system from a committed Markdown asset. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
66
|
+
| [`designSystemDelete`](/reference/management-api/schema/design-system#designsystemdelete) | Mutation | Deletes a design system. The asset that holds its guidance is kept. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
67
|
+
| [`designSystems`](/reference/management-api/schema/design-system#designsystems) | Query | Lists the design systems in a project. Scope: `ORGANIZATION_PROJECTS_READ`. |
|
|
68
|
+
| [`designSystemUpdate`](/reference/management-api/schema/design-system#designsystemupdate) | Mutation | Updates a design system's name or guidance asset. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
69
|
+
| [`emailLinkVerify`](/reference/management-api/schema/auth#emaillinkverify) | Mutation | Verifies the link from a password-reset, invitation, sign-in or confirmation email and creates a session. The link works once: call this when the recipient confirms, never on opening the link, which an email security scanner may do before delivery. |
|
|
70
|
+
| [`experience`](/reference/management-api/schema/experience#experience) | Query | Reads an experience. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
71
|
+
| [`experienceCreate`](/reference/management-api/schema/experience#experiencecreate) | Mutation | Creates an experience in a workspace. A `PAGE` experience gets its single step and flow graph automatically. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
72
|
+
| [`experienceDelete`](/reference/management-api/schema/experience#experiencedelete) | Mutation | Deletes an experience. Its steps, conditions and actions stay in the workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
73
|
+
| [`experienceFlowUpdate`](/reference/management-api/schema/experience#experienceflowupdate) | Mutation | Updates an experience's settings and flow graph, with the steps, conditions, actions and fields it uses, in one call. Validation runs before any write, and a change that fails it fails the whole call. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
74
|
+
| [`experiences`](/reference/management-api/schema/experience#experiences) | Query | Lists the experiences in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
75
|
+
| [`experienceUpdate`](/reference/management-api/schema/experience#experienceupdate) | Mutation | Updates an experience's settings. `experienceFlowUpdate` changes its flow graph. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
76
|
+
| [`externalApi`](/reference/management-api/schema/external-api#externalapi) | Query | Reads an external API. Null when it does not exist. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
77
|
+
| [`externalApiAuthHeaderClear`](/reference/management-api/schema/external-api#externalapiauthheaderclear) | Mutation | Removes the static auth header of an external API. An external API with no static header is unchanged. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
78
|
+
| [`externalApiAuthHeaderSet`](/reference/management-api/schema/external-api#externalapiauthheaderset) | Mutation | Sets the static auth header of an external API, and removes any OAuth2 credential. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
79
|
+
| [`externalApiCreate`](/reference/management-api/schema/external-api#externalapicreate) | Mutation | Creates an external API in a project, with an optional credential. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
|
|
80
|
+
| [`externalApiDelete`](/reference/management-api/schema/external-api#externalapidelete) | Mutation | Deletes an external API and its credential. Workflows then cannot call its origin. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
81
|
+
| [`externalApiOAuth2Clear`](/reference/management-api/schema/external-api#externalapioauth2clear) | Mutation | Removes the OAuth2 credential of an external API, with its secrets and cached access token. An external API with no OAuth2 credential is unchanged. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
82
|
+
| [`externalApiOAuth2Set`](/reference/management-api/schema/external-api#externalapioauth2set) | Mutation | Sets the OAuth2 credential of an external API, and removes any static auth header. The next call fetches a new access token. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
83
|
+
| [`externalApiUpdate`](/reference/management-api/schema/external-api#externalapiupdate) | Mutation | Updates the name of an external API. To change the origin, delete it and create another. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
84
|
+
| [`feature`](/reference/management-api/schema/feature#feature) | Query | Reads a feature flag by its ID and workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
85
|
+
| [`featureCreate`](/reference/management-api/schema/feature#featurecreate) | Mutation | Creates a feature flag in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
86
|
+
| [`featureDelete`](/reference/management-api/schema/feature#featuredelete) | Mutation | Deletes a feature flag. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
87
|
+
| [`features`](/reference/management-api/schema/feature#features) | Query | Lists the feature flags in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
88
|
+
| [`featureUpdate`](/reference/management-api/schema/feature#featureupdate) | Mutation | Updates a feature flag. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
89
|
+
| [`feedbackCreate`](/reference/management-api/schema/feedback#feedbackcreate) | Mutation | Sends product feedback from the signed-in user to the Picked team. |
|
|
90
|
+
| [`field`](/reference/management-api/schema/field#field) | Query | Reads a field. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
91
|
+
| [`fieldCreate`](/reference/management-api/schema/field#fieldcreate) | Mutation | Creates a field in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
92
|
+
| [`fieldDelete`](/reference/management-api/schema/field#fielddelete) | Mutation | Deletes a field. A field that is on a step is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
93
|
+
| [`fields`](/reference/management-api/schema/field#fields) | Query | Lists the fields in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
94
|
+
| [`fieldUpdate`](/reference/management-api/schema/field#fieldupdate) | Mutation | Updates a field. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
95
|
+
| [`integrationConfigurationCreate`](/reference/management-api/schema/integration#integrationconfigurationcreate) | Mutation | Creates the configuration of an installed integration. An integration has at most one configuration; a second gets a `CONFLICT` error. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
|
|
96
|
+
| [`integrationConfigurationDelete`](/reference/management-api/schema/integration#integrationconfigurationdelete) | Mutation | Deletes an integration's configuration. The integration stays installed. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
97
|
+
| [`integrationConfigurationUpdate`](/reference/management-api/schema/integration#integrationconfigurationupdate) | Mutation | Updates an integration's configuration. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
98
|
+
| [`integrationInstall`](/reference/management-api/schema/integration#integrationinstall) | Mutation | Installs an integration for a project. A project that already has an integration of that type gets a `CONFLICT` error. Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_PROJECTS_READ`. |
|
|
99
|
+
| [`integrationUninstall`](/reference/management-api/schema/integration#integrationuninstall) | Mutation | Uninstalls an integration and deletes its configuration. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
100
|
+
| [`labelsDelete`](/reference/management-api/schema/label#labelsdelete) | Mutation | Deletes labels from a lead, a project or a workflow run. Deleting a label that is not set succeeds. A `LEAD` owner needs `ORGANIZATION_LEADS_UPDATE`; the other owners need `ORGANIZATION_PROJECTS_UPDATE`. Scope: `ORGANIZATION_LEADS_UPDATE` or `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
101
|
+
| [`labelsSet`](/reference/management-api/schema/label#labelsset) | Mutation | Creates or replaces labels on a lead, a project or a workflow run. Labels the call does not name are unchanged. A `LEAD` owner needs `ORGANIZATION_LEADS_UPDATE`; the other owners need `ORGANIZATION_PROJECTS_UPDATE`. Scope: `ORGANIZATION_LEADS_UPDATE` or `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
102
|
+
| [`lead`](/reference/management-api/schema/lead#lead) | Query | Reads a lead. Scope: `ORGANIZATION_LEADS_READ`. |
|
|
103
|
+
| [`leadDelete`](/reference/management-api/schema/lead#leaddelete) | Mutation | Deletes a lead and its labels. This cannot be undone. Scope: `ORGANIZATION_LEADS_DELETE`. |
|
|
104
|
+
| [`magicLinkSend`](/reference/management-api/schema/auth#magiclinksend) | Mutation | Emails an existing account a sign-in code and link. Never creates an account, and answers `success: true` for an address with no account. |
|
|
105
|
+
| [`magicLinkVerify`](/reference/management-api/schema/auth#magiclinkverify) | Mutation | Verifies the six-digit code from a sign-in or confirmation email and creates a session. |
|
|
106
|
+
| [`mcpServer`](/reference/management-api/schema/mcp-server#mcpserver) | Query | Reads an MCP server. Null when no server has the ID. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
107
|
+
| [`mcpServerAuthHeaderClear`](/reference/management-api/schema/mcp-server#mcpserverauthheaderclear) | Mutation | Removes an MCP server's auth header. Succeeds when the server has none. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
108
|
+
| [`mcpServerAuthHeaderSet`](/reference/management-api/schema/mcp-server#mcpserverauthheaderset) | Mutation | Sets or replaces the auth header sent to an MCP server. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
109
|
+
| [`mcpServerDelete`](/reference/management-api/schema/mcp-server#mcpserverdelete) | Mutation | Deletes an MCP server with its stored URL and auth header. Cannot be undone; an unknown ID returns `NOT_FOUND`. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
110
|
+
| [`mcpServerRegister`](/reference/management-api/schema/mcp-server#mcpserverregister) | Mutation | Registers a third-party MCP server to a project. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
|
|
111
|
+
| [`mcpServerUpdate`](/reference/management-api/schema/mcp-server#mcpserverupdate) | Mutation | Renames an MCP server. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
112
|
+
| [`mcpServerUrlSet`](/reference/management-api/schema/mcp-server#mcpserverurlset) | Mutation | Replaces an MCP server's URL. The result shows only `urlDisplay`. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
113
|
+
| [`mfaChallengeCreate`](/reference/management-api/schema/auth#mfachallengecreate) | Mutation | Opens a challenge against one of the caller's factors. |
|
|
114
|
+
| [`mfaChallengeVerify`](/reference/management-api/schema/auth#mfachallengeverify) | Mutation | Verifies an authenticator code against a challenge and returns the caller's session at `AAL2`. The user's other sessions keep their level. A wrong code returns `MFA_CHALLENGE_FAILED`, and an expired challenge `TOKEN_EXPIRED`. |
|
|
115
|
+
| [`mfaFactorEnroll`](/reference/management-api/schema/auth#mfafactorenroll) | Mutation | Enrols an authenticator app for the caller and returns its secret, once. First deletes the caller's unverified factors, except the two newest enrolled in the last minute; one holding the given `friendlyName` is deleted however new. |
|
|
116
|
+
| [`mfaFactorUnenroll`](/reference/management-api/schema/auth#mfafactorunenroll) | Mutation | Removes one of the caller's factors. Removing a verified factor needs an `AAL2` session, and otherwise returns `MFA_REQUIRED`. A user the MFA policy requires cannot remove their last verified factor (`VALIDATION_ERROR`). |
|
|
117
|
+
| [`oauthAuthorize`](/reference/management-api/schema/auth#oauthauthorize) | Mutation | Creates the provider URL that starts a sign-in with an OAuth provider. |
|
|
118
|
+
| [`oauthCallback`](/reference/management-api/schema/auth#oauthcallback) | Mutation | Exchanges the authorisation code from an OAuth provider's redirect for a session. |
|
|
119
|
+
| [`oauthConsentApprove`](/reference/management-api/schema/auth#oauthconsentapprove) | Mutation | Approves an OAuth authorisation request for the signed-in user. |
|
|
120
|
+
| [`oauthConsentDeny`](/reference/management-api/schema/auth#oauthconsentdeny) | Mutation | Denies an OAuth authorisation request for the signed-in user. |
|
|
121
|
+
| [`oauthConsentDetails`](/reference/management-api/schema/auth#oauthconsentdetails) | Query | Reads an OAuth authorisation request waiting for the signed-in user's consent. Reading a request the user already consented to approves it. |
|
|
122
|
+
| [`organization`](/reference/management-api/schema/organization#organization) | Query | Reads an organisation by ID or slug. Null when no organisation matches. Scope: `ORGANIZATION_READ`. |
|
|
123
|
+
| [`organizationClientManagerScopesUpdate`](/reference/management-api/schema/organization#organizationclientmanagerscopesupdate) | Mutation | Sets the scopes a client manager holds in one organisation. The caller cannot edit their own scopes, and a client manager can add or remove only scopes they hold there themselves. Scope: `STAFF_INVITE_CLIENT_MANAGER`. |
|
|
124
|
+
| [`organizationCreate`](/reference/management-api/schema/organization#organizationcreate) | Mutation | Creates an organisation owned by the calling user. Scope: `ORGANIZATION_CREATE`. |
|
|
125
|
+
| [`organizationDelete`](/reference/management-api/schema/organization#organizationdelete) | Mutation | Deletes an organisation. Scope: `ORGANIZATION_DELETE`. |
|
|
126
|
+
| [`organizationInvitationAccept`](/reference/management-api/schema/organization#organizationinvitationaccept) | Mutation | Accepts an invitation, making the calling user a member with the scopes it carries. The invitation is used up. An unknown or expired token, or an existing membership, fails. |
|
|
127
|
+
| [`organizationInvitationDecline`](/reference/management-api/schema/organization#organizationinvitationdecline) | Mutation | Declines an invitation addressed to the calling user's email address and deletes it. |
|
|
128
|
+
| [`organizationInvitationRevoke`](/reference/management-api/schema/organization#organizationinvitationrevoke) | Mutation | Revokes a pending invitation, so its token stops working. Scope: `ORGANIZATION_INVITATIONS_DELETE`. |
|
|
129
|
+
| [`organizationMemberInvite`](/reference/management-api/schema/organization#organizationmemberinvite) | Mutation | Invites an email address to an organisation and emails the invitee. `delivery` says which email went out. Scope: `ORGANIZATION_INVITATIONS_CREATE`. |
|
|
130
|
+
| [`organizationMemberRemove`](/reference/management-api/schema/organization#organizationmemberremove) | Mutation | Removes a member from an organisation, with every scope they held there. The primary owner cannot be removed. Scope: `ORGANIZATION_MEMBERS_DELETE`. |
|
|
131
|
+
| [`organizationMemberScopesUpdate`](/reference/management-api/schema/organization#organizationmemberscopesupdate) | Mutation | Sets the scopes a member holds in an organisation. The caller cannot edit their own scopes, grant a scope they do not hold, or take `ORGANIZATION_MEMBERS_MANAGE_SCOPES` from the primary owner. Scope: `ORGANIZATION_MEMBERS_MANAGE_SCOPES`. |
|
|
132
|
+
| [`organizations`](/reference/management-api/schema/organization#organizations) | Query | Lists the organisations the user belongs to. `search` matches a case-insensitive substring of the name. Empty for an API key. |
|
|
133
|
+
| [`organizationShopifyWebhooks`](/reference/management-api/schema/shopify#organizationshopifywebhooks) | Query | Lists an organisation's Shopify webhooks. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
134
|
+
| [`organizationUpdate`](/reference/management-api/schema/organization#organizationupdate) | Mutation | Updates an organisation. Scope: `ORGANIZATION_UPDATE`. |
|
|
135
|
+
| [`passwordResetSend`](/reference/management-api/schema/auth#passwordresetsend) | Mutation | Sends a password-reset email. Returns `RATE_LIMITED` when the address was emailed within the minimum send interval or the project's email quota is spent. |
|
|
136
|
+
| [`passwordUpdate`](/reference/management-api/schema/auth#passwordupdate) | Mutation | Sets the signed-in user's password without asking for the current one. Ends the user's other sessions and keeps the caller's. An `AAL1` session may set a password only while the user holds no verified factor, and otherwise gets `MFA_REQUIRED`. |
|
|
137
|
+
| [`pickedqlQuery`](/reference/management-api/schema/analytics#pickedqlquery) | Query | Runs a PickedQL query against one project's analytics data. A statement that does not parse, or queries a project's data without a `project_id` filter, fails with `VALIDATION_ERROR`. Scope: `ORGANIZATION_REPORTS_READ`. |
|
|
138
|
+
| [`ping`](/reference/management-api/schema/common#ping) | Query | Checks that the API is up. Answers `pong`. |
|
|
139
|
+
| [`project`](/reference/management-api/schema/project#project) | Query | Reads a project. Null when no project has the ID. Scope: `ORGANIZATION_PROJECTS_READ`. |
|
|
140
|
+
| [`projectCreate`](/reference/management-api/schema/project#projectcreate) | Mutation | Creates a project, with a draft workspace named `Default`. Scope: `ORGANIZATION_PROJECTS_CREATE`. |
|
|
141
|
+
| [`projectDelete`](/reference/management-api/schema/project#projectdelete) | Mutation | Deletes a project. Scope: `ORGANIZATION_PROJECTS_DELETE`. |
|
|
142
|
+
| [`projectPreviewEnvironmentCreate`](/reference/management-api/schema/project#projectpreviewenvironmentcreate) | Mutation | Creates a preview environment on a project. Invalid input comes back as `userErrors`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
143
|
+
| [`projectPreviewEnvironmentDelete`](/reference/management-api/schema/project#projectpreviewenvironmentdelete) | Mutation | Deletes a preview environment. An unknown ID comes back as `userErrors`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
144
|
+
| [`projectPreviewEnvironmentUpdate`](/reference/management-api/schema/project#projectpreviewenvironmentupdate) | Mutation | Updates a preview environment. Invalid input comes back as `userErrors`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
145
|
+
| [`projects`](/reference/management-api/schema/project#projects) | Query | Lists the projects the user can reach, across every organisation they belong to. `search` matches a case-insensitive substring of the name. Empty for an API key. |
|
|
146
|
+
| [`projectShopifyMetafieldConfigs`](/reference/management-api/schema/shopify#projectshopifymetafieldconfigs) | Query | Lists a project's Shopify metafield configs. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
147
|
+
| [`projectUpdate`](/reference/management-api/schema/project#projectupdate) | Mutation | Updates a project's name or brief. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
148
|
+
| [`report`](/reference/management-api/schema/report#report) | Query | Reads a project report. Null when no project report has the ID. Scope: `ORGANIZATION_REPORTS_READ`. |
|
|
149
|
+
| [`reportCreate`](/reference/management-api/schema/report#reportcreate) | Mutation | Creates a report and adds it to a project. Scope: `ORGANIZATION_REPORTS_CREATE`. |
|
|
150
|
+
| [`reportDelete`](/reference/management-api/schema/report#reportdelete) | Mutation | Deletes a report from its project, and the report itself when no other project uses it. Scope: `ORGANIZATION_REPORTS_DELETE`. |
|
|
151
|
+
| [`reportUpdate`](/reference/management-api/schema/report#reportupdate) | Mutation | Updates a project report and its report. Scope: `ORGANIZATION_REPORTS_UPDATE`. |
|
|
152
|
+
| [`savedView`](/reference/management-api/schema/saved-view#savedview) | Query | Reads a saved view. Scope: `ORGANIZATION_PROJECTS_READ`. |
|
|
153
|
+
| [`savedViewCreate`](/reference/management-api/schema/saved-view#savedviewcreate) | Mutation | Creates a saved view of a list in a project. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
154
|
+
| [`savedViewDelete`](/reference/management-api/schema/saved-view#savedviewdelete) | Mutation | Deletes a saved view. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
155
|
+
| [`savedViewUpdate`](/reference/management-api/schema/saved-view#savedviewupdate) | Mutation | Updates a saved view: its name, its controls, or whether it is the default. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
|
|
156
|
+
| [`sessionCreate`](/reference/management-api/schema/auth#sessioncreate) | Mutation | Signs in with an email address and password and returns an `AAL1` session. |
|
|
157
|
+
| [`sessionRefresh`](/reference/management-api/schema/auth#sessionrefresh) | Mutation | Exchanges a refresh token for a new session. |
|
|
158
|
+
| [`sessionStart`](/reference/management-api/schema/auth#sessionstart) | Mutation | Begins a sign-in from an email address alone: answers `PASSWORD`, or emails a sign-in code and answers `EMAIL_CODE`. Never creates an account. Returns `RATE_LIMITED` past 10 requests a minute from one IP address, or when the project's email quota is spent. |
|
|
159
|
+
| [`shopifyCollectionContentUpdate`](/reference/management-api/schema/shopify#shopifycollectioncontentupdate) | Mutation | Updates the content at `key` of a Shopify collection, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
160
|
+
| [`shopifyMetafieldConfigCreate`](/reference/management-api/schema/shopify#shopifymetafieldconfigcreate) | Mutation | Creates a Shopify metafield config for a project. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
|
|
161
|
+
| [`shopifyMetafieldConfigDelete`](/reference/management-api/schema/shopify#shopifymetafieldconfigdelete) | Mutation | Deletes a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
162
|
+
| [`shopifyMetafieldConfigs`](/reference/management-api/schema/shopify#shopifymetafieldconfigs) | Query | Lists a project's Shopify metafield configs. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
163
|
+
| [`shopifyMetafieldConfigUpdate`](/reference/management-api/schema/shopify#shopifymetafieldconfigupdate) | Mutation | Updates a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
164
|
+
| [`shopifyProduct`](/reference/management-api/schema/shopify#shopifyproduct) | Query | Reads a Shopify product. Always returns null. |
|
|
165
|
+
| [`shopifyProductContentUpdate`](/reference/management-api/schema/shopify#shopifyproductcontentupdate) | Mutation | Updates the content at `key` of a Shopify product, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
166
|
+
| [`shopifyProducts`](/reference/management-api/schema/shopify#shopifyproducts) | Query | Lists Shopify products. Always returns an empty page. |
|
|
167
|
+
| [`shopifyWebhookCreate`](/reference/management-api/schema/shopify#shopifywebhookcreate) | Mutation | Creates a Shopify webhook for a project and generates its HMAC secret. The result is the only place the secret appears. Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
168
|
+
| [`shopifyWebhookDelete`](/reference/management-api/schema/shopify#shopifywebhookdelete) | Mutation | Deletes a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
|
|
169
|
+
| [`shopifyWebhooks`](/reference/management-api/schema/shopify#shopifywebhooks) | Query | Lists an organisation's Shopify webhooks. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
|
|
170
|
+
| [`shopifyWebhookUpdate`](/reference/management-api/schema/shopify#shopifywebhookupdate) | Mutation | Updates a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
171
|
+
| [`step`](/reference/management-api/schema/step#step) | Query | Reads a step. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
172
|
+
| [`stepCreate`](/reference/management-api/schema/step#stepcreate) | Mutation | Creates a step in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
173
|
+
| [`stepDelete`](/reference/management-api/schema/step#stepdelete) | Mutation | Deletes a step. A step that an experience references is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
174
|
+
| [`steps`](/reference/management-api/schema/step#steps) | Query | Lists the steps in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
175
|
+
| [`stepUpdate`](/reference/management-api/schema/step#stepupdate) | Mutation | Updates a step. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
176
|
+
| [`tenant`](/reference/management-api/schema/tenant-branding#tenant) | Query | Reads a tenant and its branding by slug or hostname. Returns the default tenant when neither matches. Needs no authentication, and responses are cacheable for 5 minutes. |
|
|
177
|
+
| [`updateShopifyCollectionContent`](/reference/management-api/schema/shopify#updateshopifycollectioncontent) | Mutation | Updates the content at `key` of a Shopify collection, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
178
|
+
| [`updateShopifyMetafieldConfig`](/reference/management-api/schema/shopify#updateshopifymetafieldconfig) | Mutation | Updates a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
179
|
+
| [`updateShopifyProductContent`](/reference/management-api/schema/shopify#updateshopifyproductcontent) | Mutation | Updates the content at `key` of a Shopify product, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
180
|
+
| [`updateShopifyWebhook`](/reference/management-api/schema/shopify#updateshopifywebhook) | Mutation | Updates a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
|
|
181
|
+
| [`user`](/reference/management-api/schema/auth#user) | Query | Reads the signed-in user. Null when the caller is an API key or the auth service rejects the token. Exempt from the MFA policy, so a user the policy gates can read `mfa` and `mfaFactors`. |
|
|
182
|
+
| [`viewerScopes`](/reference/management-api/schema/auth#viewerscopes) | Query | Lists the scopes the caller holds outside any organisation, such as `ORGANIZATION_CREATE`. Empty for an API key. `Organization.viewerScopes` lists the scopes held in one organisation. |
|
|
183
|
+
| [`workbenchAssetAdoptOwned`](/reference/management-api/schema/workbench#workbenchassetadoptowned) | Mutation | Moves the ownership of an asset-library asset to a workbench, as `OWNED`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
184
|
+
| [`workbenchAssetImport`](/reference/management-api/schema/workbench#workbenchassetimport) | Mutation | Imports an asset owned elsewhere into a workbench as `IMPORTED`. The asset's owner does not change. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
185
|
+
| [`workbenchAssetRemove`](/reference/management-api/schema/workbench#workbenchassetremove) | Mutation | Removes an asset from a workbench. Removing an `OWNED` asset also deletes it, which needs `ORGANIZATION_PROJECTS_UPDATE` and fails once a publish uses the asset. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
186
|
+
| [`workflow`](/reference/management-api/schema/workflow#workflow) | Query | Reads a workflow. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
187
|
+
| [`workflowCreate`](/reference/management-api/schema/workflow#workflowcreate) | Mutation | Creates a workflow in a workspace. The caller must hold the scopes the tools of the graph need, as `Workflow.scopes` describes. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
188
|
+
| [`workflowDelete`](/reference/management-api/schema/workflow#workflowdelete) | Mutation | Deletes a workflow. Published versions keep their copy, and an action that started it can start another workflow. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
189
|
+
| [`workflowGraphUpdate`](/reference/management-api/schema/workflow#workflowgraphupdate) | Mutation | Updates the graph of a workflow with a change set, all or nothing. A refused change set writes nothing and comes back in `errors`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
190
|
+
| [`workflowRun`](/reference/management-api/schema/workflow-run#workflowrun) | Query | Reads a workflow run. Scope: `ORGANIZATION_PROJECTS_READ`. |
|
|
191
|
+
| [`workflows`](/reference/management-api/schema/workflow#workflows) | Query | Lists the workflows in a workspace. `search` matches a case-insensitive substring of the name. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
192
|
+
| [`workflowTestRun`](/reference/management-api/schema/workflow#workflowtestrun) | Mutation | Tests a workflow by walking its draft graph once, holding back every write. Nothing is stored, and the caller must also hold every scope in `Workflow.scopes`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
193
|
+
| [`workflowTools`](/reference/management-api/schema/workflow#workflowtools) | Query | Lists every tool a workflow node can run, with the arguments each takes. |
|
|
194
|
+
| [`workflowUpdate`](/reference/management-api/schema/workflow#workflowupdate) | Mutation | Updates the name or the node visit limit of a workflow. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
195
|
+
| [`workspace`](/reference/management-api/schema/workspace#workspace) | Query | Reads a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
196
|
+
| [`workspaceArchive`](/reference/management-api/schema/workspace#workspacearchive) | Mutation | Archives a workspace, which moves it out of the default list. It stays editable. Archiving an archived workspace changes nothing. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
197
|
+
| [`workspaceContentEntryValidation`](/reference/management-api/schema/cms-models#workspacecontententryvalidation) | Query | Verifies each content entry in a workspace against its model's schema, including embedded blocks. It changes no data. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
198
|
+
| [`workspaceCreate`](/reference/management-api/schema/workspace#workspacecreate) | Mutation | Creates an empty draft workspace in a project. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
199
|
+
| [`workspaceDelete`](/reference/management-api/schema/workspace#workspacedelete) | Mutation | Deletes a workspace that is not live. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
200
|
+
| [`workspaceDiff`](/reference/management-api/schema/workspace-version#workspacediff) | Query | Compares two workspace snapshots and lists the entities added, removed and modified. Each side is a workspace at its current content or a published version, and both sides must belong to one project. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
201
|
+
| [`workspaceDuplicate`](/reference/management-api/schema/workspace#workspaceduplicate) | Mutation | Copies a workspace and every entity in it, workflows included, into a new draft workspace in the same project. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
202
|
+
| [`workspaceExport`](/reference/management-api/schema/workspace#workspaceexport) | Query | Exports a workspace and every entity in it as a JSON bundle that `workspaceImport` reads. The bundle lists the asset versions its content references; download each file from its `downloadUrl`. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
203
|
+
| [`workspaceImport`](/reference/management-api/schema/workspace#workspaceimport) | Mutation | Creates a draft workspace in a project from a bundle that `workspaceExport` returned. Every entity gets a new ID, and every reference between entities, assets through `assetMap` included, points at the new IDs. Nothing is created when a `userError` is returned. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
204
|
+
| [`workspacePublish`](/reference/management-api/schema/workspace#workspacepublish) | Mutation | Publishes a workspace: makes an immutable version of it and serves that version to visitors. The workspace becomes `LIVE`, and an archived workspace returns to the default list. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
205
|
+
| [`workspaceUnarchive`](/reference/management-api/schema/workspace#workspaceunarchive) | Mutation | Unarchives a workspace, which returns it to `DRAFT`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
206
|
+
| [`workspaceUpdate`](/reference/management-api/schema/workspace#workspaceupdate) | Mutation | Renames a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
207
|
+
| [`workspaceVersionPublish`](/reference/management-api/schema/workspace#workspaceversionpublish) | Mutation | Makes a published version the version its project serves. No new version is made and the workspace's draft does not change; the workspace becomes `LIVE`, and an archived one returns to the default list. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
208
208
|
|
|
209
209
|
## Domains
|
|
210
210
|
|