Skip to main content

Update Integration Instance

PATCH 
/api/shiprush/instances/:integration_instance

Updates settings on an existing ShipRush integration instance. Every field is optional (the settings UI POSTs partial per-tab payloads) — send only what should change; omitted fields are left untouched. Accepts PUT or PATCH. Returns the updated instance with a refreshed dashboard summary.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Path parameter:

  • instance: the numeric ID of the ShipRush integration instance.

Body fields (all optional):

  • name (string): connection label. Max 255 characters.
  • environment (string): "production" or "sandbox".
  • shipping_api_token (string, nullable): rotate or clear the ShipRush Shipping API token. Max 255 characters. Send null to clear it.
  • record_shipping_costs (boolean): capture ShipRush shipping costs against orders.
  • sync_start_date (date, nullable): earliest order date ShipRush can pull from the export feed (YYYY-MM-DD). When empty, the feed uses a rolling 90-day window.
  • tracking_refresh_enabled (boolean): whether the scheduled tracking refresh (every 4 hours) runs for this instance. Only has an effect when a Shipping API token is configured. Default true.

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

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type