Update Integration Instance

PUT 
/api/magento1/instances/:integrationInstance

Updates a Magento 1 integration instance. All fields are optional — only the keys you send are changed. Credentials are merged, so omitting connection_settings.api_key keeps the stored key intact rather than clearing it.

Request body fields (all optional):

• name (string), is_automatic_sync_enabled (boolean).
• connection_settings (object) — any of store_base_url, api_user, api_key.
• start_date (string, YYYY-MM-DD, nullable).
• inventory (object) — same shape as on create.
• refunds (object) — outbound refund settings: allow_refunds_from_sku (boolean, default false) enables issuing refunds to Magento 1 from SKU. Refunds are recorded as offline credit memos on the Magento order — no money moves on the channel; the customer must be refunded through the payment processor separately.

Authentication: Requires Bearer token.

Request

Responses

200

OK

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.