Update Account

Update shipping account details.
Note: All required fields must be populated in the request, regardless if they need updating or not.

Path Params
string
required

Shipping Account Identifier
SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).

Body Params

Shipping Account Details

string
enum
required

Indicates whether the account is set up as a "sandbox" or "production" account. A Sandbox account is for testing and development, while a Production account is used for live shipments and transactions.

Allowed:
string
required
length between 1 and 35

The official name of the shipping account as designated by the user or organization, aiding in easy identification and reference of accounts.

Note: By default, this value is set to the customer name if not provided in the request.

string
required
length between 1 and 30

A unique, user-defined name for the shipping account, providing a convenient way to reference the account in a more memorable manner.

string
required
length between 1 and 100

The name of the primary contact person for the shipping account, facilitating communication regarding shipping and account-related matters.

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact name, if provided.

string
required
length between 1 and 20

The phone number associated with the shipping account's primary contact person, facilitating communication regarding shipping inquiries, account management, and issue resolution.

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact phone number, if provided. Characters like +, /, -, or space are supported.

string
required
length between 1 and 20

Carrier Account Number
The account number given by the carrier.

string
required
length between 1 and 50

Password for authentication

string
required
length between 2 and 2

Customer Account Service Centre

string
enum
required

Accepted Values: 1 Man and 2 Man

Allowed:
Responses
200

The shipping account was updated successfully.

401

Unauthorized

403

Forbidden

404

The shipping account was not found.

500

Internal Server Error

Language
Credentials
OAuth2
Response
Choose an example:
application/json