Skip to main content
PATCH
Update Address

Authorization

string
required
Bearer token. Format: Bearer qwoty_your_token

Path Parameters

string
required
UUID of the address to update

Request Body

All fields are optional. Only the fields provided will be updated.
string
Address type. Allowed values: "billing", "shipping"
string | null
Address label. Set to null to unset.
string
Street address
string | null
Secondary address line. Set to null to unset.
string
City
string | null
State or region. Set to null to unset.
string
Postal/ZIP code
string
Country code (ISO 3166-1 alpha-2)
string | null
UUID of the associated contact. Set to null to unset.
string | null
Internal comment. Set to null to unset.
string | null
External CRM ID
string | null
External ERP ID
string | null
External accounting ID
customer_id cannot be changed after creation.

Examples

Response

boolean
true if the update succeeded
object
The updated address object (same shape as Get Address)