Skip to main content

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).

Required scope: integrations:write

Grant 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​

OK

Response Headers
    Content-Type