Update a carrier account

Updates an existing carrier account object. The account_id and carrier can't be updated. This is because they form the unique identifier together.

SecurityAPIKeyHeader
Request
path Parameters
CarrierAccountId
required
string

Object ID of the carrier account

header Parameters
SHIPPO-API-VERSION
string

String used to pick a non-default API version to use

Example: 2018-02-08
Request Body schema: application/json

Examples.

account_id
required
string

Unique identifier of the account. Please check the carrier accounts tutorial page for the account_id per carrier.
To protect account information, this field will be masked in any API response.

active
boolean

Determines whether the account is active. When creating a shipment, if no carrier_accounts are explicitly passed Shippo will query all carrier accounts that have this field set. By default, this is set to True.

carrier
required
string

Carrier token, see Carriers
Please check the carrier accounts tutorial page for all supported carriers.

Account parameters (any) or FedEx account parameters (object) or UPS account parameters (object)
Responses
200
400
put/carrier_accounts/{CarrierAccountId}
Request samples
application/json
{
  • "account_id": 123356,
  • "active": true,
  • "carrier": "ups",
  • "parameters": { }
}
Response samples
application/json
{
  • "account_id": "****",
  • "active": true,
  • "carrier": "usps",
  • "parameters": { },
  • "carrier_name": "USPS",
  • "is_shippo_account": false,
  • "metadata": "string",
  • "object_id": "6aa34d5f6865448fbb1ee93636e98999",
  • "object_owner": "bob+22@gmail.com",
  • "service_levels": [
    ],
  • "test": false
}