PATCH/stores/{storeId}/v1/webhook-subscriptions/{id}
No scope required
Path parameters
- idstring (uuid)required
Request body
- stateobject
active paused- event_typesarray<string>
Response
- dataobjectrequired
- idstring (uuid)
- endpoint_urlstring (uri)
- event_typesarray<string>
- payload_versionobject
- stateobject
active paused revoked- secret_generationinteger
- issued_scopesarray<string>
- executionobject
- Who executed the request: the app, version, installation and store. Field names here are camelCase.
- appIdstring (uuid)
- versionIdstring (uuid)
- installationIdstring (uuid)
- storeIdstring (uuid)
- requestIdstring (uuid)
- generationinteger
- routeEpochinteger
- appAuthEpochinteger
- grantRevisioninteger
- metaobjectrequired
- request_idstring (uuid)
- The request ID; include it in any support request.
Errors
| HTTP | Code | Meaning |
|---|
| 403 | SUBSCRIPTION_EXPANSION_REQUIRES_RECONSENT | Adding topics requires a new subscription. |
| 400 | INVALID_STATE | The state can only be active or paused. |
Shared codes are listed in Errors.
