Update Address

put

https://api.intersoftsapient.net/v4/addresses/{addressId}

Modify the details of an existing address record in the system's address book. With this endpoint, you can submit updated information for a specific address, ensuring that it reflects the most current and accurate data.

Path Params

addressId

string

required

A unique identifier for each existing address record stored in the address book. This information ensures that each address can be distinctly referenced and managed within the system.

Body Params

Address Book details

Update AddAddressBook Request

ContactName

string | null

The name of the primary contact associated with the address. This field is essential for identification and communication purposes.

CompanyName

string | null

The name of the company linked to the address. This field provides context for the address, especially in business-related queries.

ContactEmail

string | null

The email address of the primary contact for the address. This is used for correspondence and can facilitate communication directly related to the address.

ContactPhone

string | null

The phone number of the primary contact associated with the address. This field is crucial for any immediate communication needs.

Line1

string

required

length between 1 and 50

The first line of the address, typically containing the primary address information such as house number and street name.

Line2

string | null

An optional second line for the address, often used for additional details like apartment numbers or suite designations.

Line3

string | null

A third optional line in the address to include any further address specifications, allowing for more detailed address information if necessary.

Town

string

required

length between 1 and 50

The town or city, indicating the specific locality where the address is located.

Postcode

string | null

The postal or ZIP code corresponding to the address, used to identify specific geographic areas.

County

string | null

The county, state, or province in which the address is located, providing additional geographical context for the address.

CountryCode

string

required

length between 2 and 2

An abbreviation representing the country of the address, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom.

What3Words

string | null

A three-word location identifier provided by the What3words service, offering a precise way to define addresses using a unique combination of three words, for example, the front door of 10 Downing Street in London is identified by slurs.this.shark.

Responses

200

The address book was updated successfully.

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

400Invalid request response.