Update Integration Instance
PUT/api/starshipit/integration-instances/:integration_instance
Updates a StarShipIt integration instance. All body fields are optional — send only what should change.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Merge semantics: top-level keys inside connection_settings and integration_settings are merged into the stored objects. Keys you send overwrite existing values; keys you omit are preserved. For example, sending only integration_settings.sync_days_back leaves the stored fulfillment routing untouched.
Body fields:
name(string, optional) — must remain unique across all integration instances.connection_settings(object, optional) — any ofapiKey,subscriptionKey,webhookSecret.integration_settings(object, optional) — any ofsync_days_back,order_start_date,fulfillment(withenabledWarehousesIds/automatedWarehousesIds).is_automatic_sync_enabled(boolean, optional).
A PATCH request to the same URL behaves identically to PUT.
Returns the full updated instance. Returns 422 when the new name is already taken; 404 when the instance does not exist.
Authentication: Requires Bearer token.
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.
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.