Update Integration Instance
PUT/api/integration-instances/:integration_instance
Update an integration instance. Settings are merged (not replaced) with existing settings.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token + Power User access.
All fields are optional. Name must be unique.
If inventory settings change for a sales channel integration, triggers inventory cache invalidation. If pricing settings change, triggers product listing price cache refresh. For sales channel integrations: syncs accounting transaction statuses if sync settings change.
Allowed integration_settings.batch_period_sales_order_fulfillments values: daily, monthly, none.
Requires permission: integrations.update
accounting_sync is returned ONLY for accounting connections (Xero, QuickBooks Online) and is absent on every other integration. It reports the state that actually governs whether accounting transactions sync: is_connection_active (whether the connection itself is live), plus types_enabled and types_total (how many transaction types are switched on). For accounting connections the is_automatic_sync_enabled and is_sync_schedule_paused fields do NOT determine sync behaviour — use accounting_sync instead.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.