Complete Provider Cutover
POST/api/integration-instances/:integration_instance/cutover/complete
Closes an in-progress cutover: status complete, a summary is written to the integration's activity log and added to history, and duplicate protection goes back to its previous setting (hold by default).
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body (optional):
force(boolean) — complete even though pre-boundary orders are still waiting for the provider's order (they stay held for review)keep_link_policy(boolean) — keep linking strong matches instead of restoring the previous setting
Errors: 422 when no cutover is in progress; initial_pass_pending until the start's pass has linked or held the open pre-boundary orders (initial_holds_applied_at is set), even with force; or pre_boundary_orders when any pre-boundary order is unresolved (held by this cutover, or open and unsent) and force is not set.
Returns the full cutover state.
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.