Update Account

Update the details of an existing shipping account. With this endpoint, you can modify various attributes of the shipping account, such as contact information, service options, and others. This helps maintain current and accurate information for effective shipping operations.

Path Params
string
required

A unique identifier for the shipping account assigned by the system (ShippingAccountId) or by you (AccountAlias), allowing for efficient reference and management of individual accounts within the system.

Body Params

Shipping Account Details

Evri Update Shipping Account Request

string
required
length between 1 and 10
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 32

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.

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.

string
required
length between 1 and 256

The username linked to the customer account for Evri API. This is typically the login credential used by the customer to access their shipping account. The username is essential for authentication purposes, ensuring that only authorised users can manage shipments and account information.

string
required
length between 1 and 256

The password associated with your Evri API. It is essential for securing the account and ensuring that only authorised users have access to shipping details and operations.

string | null

A specific code associated with SMS notifications allocated by Evri. This code identifies the group or category of SMS alerts that the customer has opted to receive regarding their shipments. It allows them to receive timely updates about their shipments via SMS, improving communication and tracking efficiency for deliveries.

Note: This information is required if the SMS notification enhanement has been selected in the Create Shipment request.

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
LoadingLoading…
Response
Choose an example:
application/json