Skip to main content
PATCH
Partially update address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Path Parameters

addressId
string
required

The ID of the address.

Minimum string length: 1
Example:

"adr_ekq4ymw1nyyd4b6k6f5tg3t6"

Body

application/json

Request body used to partially update an existing address resource.

Request body used to partially update an existing address resource.

name
string

Display label for the address, typically the legal entity name.

Required string length: 1 - 200
Example:

"Acme Corporation"

registrationNumber
string | null

Company registration number associated with the address.

Maximum string length: 100
Example:

"ACME-123"

vatNumber
string | null

VAT number for the entity at this address.

Maximum string length: 100
Example:

"VAT-987654"

address1
string

Primary address line.

Required string length: 1 - 200
Example:

"123 Main St"

address2
string

Secondary address line.

Maximum string length: 200
Example:

"Suite 400"

region
string

State or region for the address.

Maximum string length: 100
Example:

"California"

country
string

Country for the address.

Required string length: 1 - 100
Example:

"United States"

city
string

City for the address.

Required string length: 1 - 100
Example:

"San Francisco"

zip
string

Postal or ZIP code.

Required string length: 1 - 20
Example:

"94103"

order
integer

Order of the resource for sorting purposes.

Required range: 0 <= x <= 9007199254740991
Example:

13

clientId
string | null

Unique identifier of the client.

Minimum string length: 1
Example:

"clnt_z2b3mo8qa5kzptgsu26q2wmh"

Response

Default Response

Standard success response payload wrapped in a data property.

data
object
required

Address resource returned by the API.