Site Logo

Update Carrier Accounts

The ShipEngine API provides the ability to update the connection information for certain carriers. This allows you to update your authentication information without disconnecting and reconnecting the carrier.

Requirements

  • This lesson assumes you know how to List Your Carriers.
  • You will need a carrier_id for this request.

Stamps Carrier Account Information Model

PropertyDescription
nicknamestring, required
usernamestring, required
passwordstring, required

Endicia Carrier Account Information Model

PropertyDescription
nicknamestring, required
accountstring, required
passphrasestring, required

PUT /v1/connections/carriers/:carrier_name/:carrier_id

Example Requests

Stamps Request Body

1
2
3
4
5
6
7
8
9
10
PUT /v1/connections/carriers/stamps_com/se-12345678 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "new nickname",
"username": "newusername",
"password": "supersecretpassword"
}

Endicia Request Body

1
2
3
4
5
6
7
8
9
10
PUT /v1/connections/carriers/endicia/se-12345678 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "new nickname",
"account": "newusername",
"passphrase": "supersecretpassword"
}

Example Response

This response will be the same for both Stamps and Endicia.

1
2
3
{
"carrier_id": "se-12345678"
}