put_addresses_by_address_reference_id
Update an existing address by its reference ID, modifying fields like address lines, locality, region code, and coordinates.
Instructions
Update address — Required permission: Account information, Edit. — [PUT /public/v2/addresses/{addressReferenceId}]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| addressReferenceId | Yes | Reference Id of address to update | |
| addressLines | Yes | The address lines for the address. Example: 1 Rocket Road | |
| locality | No | The town/locality of the address. Example: Hawthorne | |
| administrativeArea | No | The administrative area of the address. Example: California | |
| administrativeAreaCode | Yes | The administrative area code of the address. Example: CA | |
| region | No | The region of the address. Example: United States | |
| regionCode | Yes | The region code of the address. Example: US | |
| postalCode | No | The postal code of the address. Example: 90250-6844 | |
| metadata | No | Optional field that can be used to store information about the address for external purposes | |
| formattedAddress | Yes | A user readable address. Example: 1 Rocket Road, Hawthorne, CA 90250-6844, US | |
| latitude | Yes | The required latitude of the address. Example: 33.92 | |
| longitude | Yes | The required longitude of the address. Example: -118.32 |