Record Optional Scope Step
PUT/api/shopify/:integrationInstance/optional-scopes/:scope
Record a step the merchant took to set up an optional scope, and return the refreshed overview (same shape as Get Optional Scopes).
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body:
step(string, required):asked_shopify(the access request was sent to Shopify; only changes the state of scopes that need Shopify's approval),added_to_app(the scope was added to the app and released, so the next re-authorization asks for it), orreset(back to not set up).
An unknown scope returns 404; an unknown step returns 422.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.