API Reference

Addressing

Address Maps

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Accounts

Add an account membership to an Address Map

client.addressing.addressMaps.accounts.update(stringaddressMapId, AccountUpdateParams { account_id, body } params, RequestOptionsoptions?): AccountUpdateResponse { errors, messages, success, result_info }

PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}

Remove an account membership from an Address Map

client.addressing.addressMaps.accounts.delete(stringaddressMapId, AccountDeleteParams { account_id } params, RequestOptionsoptions?): AccountDeleteResponse { errors, messages, success, result_info }

DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}

ModelsExpand Collapse

AccountUpdateResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, 2 more }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

total_pages?: number

The number of total pages in the entire result set.

AccountDeleteResponse { errors, messages, success, result_info }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result_info?: ResultInfo { count, page, per_page, 2 more }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

total_pages?: number

The number of total pages in the entire result set.