Skip to main content
POST
Update Account Settings

Authorizations

token
string
query
required

Vida API Token

Query Parameters

targetAccountId
string
required

Target Account Id to update settings for

Body

application/json
active
boolean

Account status - if set to false calls and messages will not be answered

Example:

true

accountName
string

Change Account Name

Example:

"Support Team"

externalAccountId
string

External Account Id to match with your internal system account Id. Set to null to remove it.

Example:

"AC_XXXXXXX"

externalBillingId
string

External Id to match with your internal billing system. Set to null to remove it.

Example:

"somebillingId"

Response

At least one setting was successfully updated

success
boolean
Example:

true

message
string
Example:

"Account settings updated"

updatedSettings
string[]
Example:
failedSettings
string[] | null
Example: