Addresses

Address operations are nested under a contact and use the complete contact/address hierarchy.

Address context

Both {contact} and {address} accept IDs or external identifiers. Nested binding verifies that the address belongs to the contact. Required scopes are contacts:read for reads and contacts:write for writes.

Query addresses

Global address search uses the singular path /api/v1/address and an HTTP QUERY JSON body. Required scope: contacts:read.

List addresses

Lists the addresses belonging to a contact.

Create an address

Create an address using fields from address.schema.json and, when applicable, provider-grouped custom fields.

Get an address

Returns one address in its contact context.

Update an address

Updates one address. PUT is also registered.

Delete an address

Soft-deletes the address and returns 204 No Content on success.

Restore an address

Restores a soft-deleted address under the same contact.