Skip to main content

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.

Required scope: inventory:write

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

Request​

Responses​

OK

Response Headers
    Content-Type