Update Address Book

Updates a shipping address from your address book

Path Params
string
required

Address Identifier
SAPIENT AddressId (assigned by SAPIENT or by you).

Body Params

Address Book details

Update AddAddressBook Request

string | null

Contact Name
The contact name or company name is required.
Up to 50 characters may be allowed.However it is carrier dependent. Some carriers may allow less.

string | null

Company Name
The contact name or company name is required.
Up to 50 characters may be allowed.However it is carrier dependent. Some carriers may allow less.

string | null

Contact Phone Number

string | null

Contact Phone Number

string
required
length between 1 and 50

Address Line 1
Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

string | null

Address Line 2
Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

string | null

Address Line 3
Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

string
required
length between 1 and 50

Town
Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

string | null

Postcode / Zip
Required for United Kingdom addresses and some international addresses.
The Countries API can be used to check whether postcode/zip code is required for a country.
Up to 20 characters may be allowed, however it is carrier dependent and some carriers may allow less.

string | null

County / State / Province
May be required depending on the country.
For USA, Australia and Canada, if provided, must be a valid state code or name.
The Countries API can be used to check whether county/state is required for a country.
Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

string
required
length between 2 and 2

Country Code
2 Digit ISO Country Code, per ISO 3166 Standard.

string | null

The what3words identifier for this address.

Responses
200

The address book was updated successfully.

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json