Update Integration Instance
PUT/api/shippit/instances/:integration_instance
Updates settings on an existing Shippit integration instance. All fields are optional — send only what should change; omitted fields are left untouched. Returns the updated instance with a refreshed dashboard summary.
Path parameter:
- instance: the numeric ID of the Shippit integration instance.
Body fields (all optional):
- name (string): connection label. Max 255 characters.
- api_key (string): rotate the Shippit API key. Minimum 8 characters.
- environment (string): "production" or "sandbox".
- auto_book (boolean): automatically book shipments with Shippit.
- record_shipping_costs (boolean): capture Shippit shipping costs against orders.
- default_courier_type (string, nullable): default Shippit courier type. Max 100 characters.
- sync_start_date (date, nullable): earliest order date to sync (YYYY-MM-DD).
- is_automatic_sync_enabled (boolean): whether scheduled syncs run automatically.
Returns 422 with field errors when validation fails; 404 when the instance does not exist.
Authentication: Requires a 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.
Unprocessable Entity
Response Headers
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.