Set Purple Dot Waitlist State
POST/api/purple-dot/:instance/waitlists/:waitlist/state
Opens, pauses or closes a Waitlist in Purple Dot. Only Waitlists labelled sku-io can be changed; any other returns 422 not_allowed. Shoppers can no longer pre-order a paused or closed Waitlist. A token Purple Dot rejects returns 422 invalid_token.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body: state (required): OPEN, PAUSED or CLOSED (case-insensitive).
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.