Accounts

Update an account

Changed on

Update an account's attributes

patch/platform/api/v1/accounts/{account_id}

Request

  • Base URL
    https://app.chatwoot.com
  • Auth
    • HTTP bearer
    • or API key in header api_access_token

Request body

namestring

Name of the account

localestring

The locale of the account

domainstring

The domain of the account

support_emailstring

The support email of the account

status'active' | 'suspended'

The status of the account

limitsobject

The limits of the account

custom_attributesobject

The custom attributes of the account

Example request

{
  "name": "My Account",
  "locale": "en",
  "domain": "example.com",
  "support_email": "support@example.com",
  "status": "active",
  "limits": {},
  "custom_attributes": {}
}

Response

Success

idnumber

Account ID

namestring

Name of the account

Changes