apiTokenObject

An API token is used to manage API access. You can grant basic permissions (read, write, and send), as well as activate and deactivate specific tokens.

Name Type Comments
id string The unique id for the API token. The id can be used to reference a specific API token when using the apiToken functions.
name string The name assigned to API token. The name can be used to reference a specific API token when using the apiToken functions.
permissions int The permissions assigned to the API token. An API token can have read, write, and send permissions. Each permission is assigned an int value. To assign:
  • Read = 1
  • Write = 2
  • Read, Write = 3
  • Send = 4
  • Read, Send = 5
  • Send, Write = 6
  • Read, Write, Send = 7
active boolean Whether or not the API token is active. You can always go back and activate or deactivate API tokens at a later time.
created string Tells you when the API token was created.
modified string Tells you when the API token was last modified.
accountId string The account, referenced by ID, that the API token is assigned to.