Skip to main content

Update Shiptheory Instance

PUT 

/api/shiptheory/:integration_instance

Patches any subset of name, credentials, and settings on the instance. Every field is optional and applied per section — omitted keys keep their current values; an empty password keeps the stored one. Returns the updated instance with a refreshed dashboard summary.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Path parameter:

  • integration_instance: the numeric id of the Shiptheory integration instance.

Body fields (all optional):

  • name (string): connection label. Max 255 characters.
  • connection_settings.email (string): Shiptheory account email. Max 255 characters.
  • connection_settings.password (string, nullable): rotate the Shiptheory account password (blank keeps the current one). Max 255 characters.
  • is_automatic_sync_enabled (boolean): whether scheduled syncs run automatically.
  • settings.use_rules_engine (boolean): leave unmapped shipping methods to the rules engine.
  • settings.mark_for_approval (boolean): submit shipments held for manual release.
  • settings.default_package_size_id (integer, nullable): default Shiptheory package size id.
  • settings.record_shipping_costs (boolean): write the booked shipment cost back onto the order.
  • settings.sync_start_date (date, nullable): earliest order date to sync (YYYY-MM-DD).

Returns 422 with field errors when validation fails; 404 when the instance does not exist.

Authentication: requires a Bearer token.

Instance names are unique across all of your integrations; reusing an existing name returns 422 with a name error.

Request​

Responses​

OK

Response Headers
    Content-Type