Skip to main content

Update Integration Instance

PUT 
/api/shippo/instances/:integration_instance

Updates the connection name, API token and/or any settings. Only the keys present in the body are applied, so partial payloads never wipe other values. PATCH is also accepted on this path. Settings may also be sent nested under an integration_settings object; they are flattened before validation.

Not yet available to API tokens

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

Body fields (all optional):

  • name (string): connection name. Max 255 characters.
  • api_token (string): a replacement Shippo API token. 20–255 characters, must start with shippo_test_ or shippo_live_. Setting a new token clears the instance's auth-error marker; it is not verified live here — call Test Saved Connection afterwards.
  • auto_push_orders (boolean): automatically push fulfillment orders to Shippo as orders.
  • record_shipping_costs (boolean): record purchased label costs as shipping costs on the fulfillment.
  • label_file_type (string): default label format. One of PDF_4x6, PDF, PDF_A4, PDF_A5, PDF_A6, PNG, ZPLII.
  • sync_start_date (date, nullable): earliest date the order/label syncs import from (Y-m-d).
  • is_automatic_sync_enabled (boolean): enable scheduled background syncs.

Returns 200 with the updated instance. Returns 422 with field errors when validation fails, 404 for an unknown instance.

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type