accountObject Multi-Brand Only

The account object contains information about the account associated with the API token you authenticated with. Information includes the name of the account, various settings and information such as contact information, sending allocation, frequency cap settings, time zone and locale settings, etc.

Name Type Description
id string The unique id assigned to the account.
name string The name assigned to the account.
status string The status of the account. You can update an account from unrestricted to inactive and inactive to unrestricted. You can’t change the status of a restricted account. Users will not be able to login (from the UI or the API) to accounts with a status of inactive.
generalSettings GeneralSettings[] An array of the general settings set for the account. Click in the Type column for more information.
contactInformation ContactInformation[] An array of the contact information set for the account. Click in the Type column for more information.
formatSettings FormatSettings[] An array of the formatting settings set for the account. Click in the Type columns for more information.
repliesSettings RepliesSettings[] An array of the replies settings set for the account. Click in the Type columns for more information.
allocations AccountAllocations[] An array of values corresponding to the allocations you assign to the account you are adding. Click in the Name row for more information on the items in the array.