Update Instance

PUT 
/api/shipbob/:instance

Partially update a ShipBob integration instance. Only the sections present in the request are applied; omitted sections keep their current values. The environment cannot be changed after connect. Leave api_token out to keep the stored token.

Authentication: Requires Bearer token.

Request Body (all fields optional):

• name (string) — Unique display name.
• connection_settings (object):
  • api_token (string, nullable) — New Personal Access Token (omit to keep the existing one).
  • channel_id (integer, nullable) — ShipBob channel id.
  • channel_name (string, nullable) — Channel display name.
• settings (object):
  • sync_start_date (date, nullable) — Earliest order date to sync (Y-m-d).
  • auto_create_products (boolean, nullable).
  • record_shipping_costs (boolean, nullable).
  • default_shipping_method (string, nullable).
• is_automatic_sync_enabled (boolean).

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.