Update an account

Update an account's attributes

Authorization

platformAppApiKey

api_access_token<token>

This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

In: header

Path Parameters

account_id*integer

The numeric ID of the account

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Name of the account

locale?string

The locale of the account

domain?string

The domain of the account

support_email?string

The support email of the account

status?string

The status of the account

limits?

The limits of the account

custom_attributes?

The custom attributes of the account

Response Body

`application/json`

curl -X PATCH "https://example.com/platform/api/v1/accounts/0" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": 0,
  "name": "string"
}

{
  "description": "string",
  "errors": [
    {
      "field": "string",
      "message": "string",
      "code": "string"
    }
  ]
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

`application/json`

`application/json`