Skip to main content
PATCH
/
api
/
v1
/
accounts
/
{id}
Update account
curl --request PATCH \
  --url https://app.chatwoot.com/api/v1/accounts/{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",
  "auto_resolve_after": 1440,
  "auto_resolve_message": "This conversation has been automatically resolved due to inactivity",
  "auto_resolve_ignore_waiting": false,
  "industry": "Technology",
  "company_size": "50-100",
  "timezone": "UTC"
}'
{
  "id": 123,
  "name": "<string>",
  "locale": "<string>",
  "domain": "<string>",
  "support_email": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "cache_keys": {},
  "features": [
    "<string>"
  ],
  "settings": {
    "auto_resolve_after": 123,
    "auto_resolve_message": "<string>",
    "auto_resolve_ignore_waiting": true
  },
  "custom_attributes": {
    "plan_name": "<string>",
    "subscribed_quantity": 123,
    "subscription_status": "<string>",
    "subscription_ends_on": "2023-12-25",
    "industry": "<string>",
    "company_size": "<string>",
    "timezone": "<string>",
    "logo": "<string>",
    "onboarding_step": "<string>",
    "marked_for_deletion_at": "2023-11-07T05:31:56Z",
    "marked_for_deletion_reason": "<string>"
  }
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Body

​
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"

​
auto_resolve_after
integer | null

Auto resolve conversations after specified minutes

Required range: 10 <= x <= 1439856
Example:

1440

​
auto_resolve_message
string | null

Message to send when auto resolving

Example:

"This conversation has been automatically resolved due to inactivity"

​
auto_resolve_ignore_waiting
boolean | null

Whether to ignore waiting conversations for auto resolve

Example:

false

​
industry
string

Industry type

Example:

"Technology"

​
company_size
string

Company size

Example:

"50-100"

​
timezone
string

Account timezone

Example:

"UTC"

Response

Success

​
id
number

Account ID

​
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

​
created_at
string<date-time>

The creation date of the account

​
cache_keys
object

Cache keys for the account

​
features
string[]

Enabled features for the account

​
settings
object

Account settings

​
custom_attributes
object

Custom attributes of the account

⌘I