Skip to main content

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.

Required scope: inventory:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body: state (required): OPEN, PAUSED or CLOSED (case-insensitive).

Request​

Responses​

OK

Response Headers
    Content-Type