Update Provider Cutover Plan
PUT/api/integration-instances/:integration_instance/cutover
Saves the cutover plan and sets the status to planned. Re-planning after a completed cutover starts a new one (the old one stays in history).
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body:
sales_channel_id(integer, required) — the sales channel being cut overplanned_at(date-time UTC, required)owner_user_id(integer, optional)boundary_at(date-time UTC, optional; send null to clear, omit to keep) — orders placed before it stay with the provider's own integrationboundary_order_number(string, optional) — informational: the latest provider-imported order at the boundary
Errors: 422 for validation errors, an unknown sales channel, or a cutover already in progress (cancel it to change the plan or boundary).
Returns the full cutover state (see Get Provider Cutover).
Required permission: integrations.update. A token also needs its integrations scope.
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 Content
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.