updateApiTokens

The updateApiTokens function allows you to change API token options and settings.

Syntax

writeResult = bApi.updateApiTokens(apiTokenObject[] apiTokens);

Attributes

Name Type Required Description
id string Yes 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 No The name assigned to API token. The name can be used to reference a specific API token when using the apiToken functions.
permissions int Yes 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
Note: If the permissions field is empty, all token permissions will default to 1.
active boolean No Whether or not the API token is active. You can always go back and activate or deactivate API tokens at a later time.
accountId boolean No The account, referenced by ID, that the API token is assigned to.