Skip to main content
PATCH
/
platform
/
api
/
v1
/
accounts
/
{account_id}
Update an account
curl --request PATCH \
  --url https://app.chatwoot.com/platform/api/v1/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "My Account",
  "locale": "en",
  "domain": "example.com",
  "support_email": "support@example.com",
  "status": "active",
  "limits": {},
  "custom_attributes": {}
}
'
{
  "id": 123,
  "name": "<string>"
}

Authorizations

​
api_access_token
string
header
required

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.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Body

application/json
​
name
string

Name of the account

Example:

"My Account"

​
locale
string

The locale of the account

Example:

"en"

​
domain
string

The domain of the account

Example:

"example.com"

​
support_email
string

The support email of the account

Example:

"support@example.com"

​
status
enum<string>

The status of the account

Available options:
active,
suspended
Example:

"active"

​
limits
object

The limits of the account

Example:
{}
​
custom_attributes
object

The custom attributes of the account

Example:
{}

Response

Success

​
id
number

Account ID

​
name
string

Name of the account