Go Live with Purple Dot
POST/api/purple-dot/:instance/go-live
Puts a pending (or paused) connection live: the dry-run rows are dropped and the initial sync starts in the background — every held pre-order is imported as backorder demand, then planned inventory is pushed, then every release budget. Returns the id of the background job and the updated connection. 422 already_live when the connection is live; not_allowed when it has no access token or no supply warehouse, or — for a connection that never went live — when no dry-run has succeeded for its current settings (the dry-run is still running, failed, or the supply / matching / budget settings changed since; the message says which). The connection's preview.state shows the same check. Requires integrations.sync.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
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.