Skip to main content

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).

Required scope: integrations:write

Grant 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), or reset (back to not set up).

An unknown scope returns 404; an unknown step returns 422.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type