Update Integration Instance

PUT 
/api/big-commerce/:integrationInstance

Update a BigCommerce integration instance. Supports both PUT (full update) and PATCH (partial update — merges connection_settings and integration_settings with existing values).

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Authentication: Requires Bearer token.

All fields are optional for PATCH. For PUT, provide all settings fields.

Side effects:

• If start_date changes, updates the sales channel date
• If pricing.masterOfPrice changes, dispatches a job to re-cache product listing prices
• If inventory settings change, invalidates the entire inventory cache
• If accounting sync settings change, updates related accounting transactions

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

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.

429

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.