Skip to content
Start here

Accounts

Add an account membership to an Address Map
addressing.address_maps.accounts.update(straddress_map_id, AccountUpdateParams**kwargs) -> AccountUpdateResponse
PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}
Remove an account membership from an Address Map
addressing.address_maps.accounts.delete(straddress_map_id, AccountDeleteParams**kwargs) -> AccountDeleteResponse
DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}
ModelsExpand Collapse
class AccountUpdateResponse:
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

total_pages: Optional[float]

The number of total pages in the entire result set.

class AccountDeleteResponse:
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

total_pages: Optional[float]

The number of total pages in the entire result set.