Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
teams
Create a team
curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/teams \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '{
  "name": "Support Team",
  "description": "This is a team of support agents",
  "allow_auto_assign": true
}'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "allow_auto_assign": true,
  "account_id": 123,
  "is_member": true
}

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

application/json
​
name
string

The name of the team

Example:

"Support Team"

​
description
string

The description of the team

Example:

"This is a team of support agents"

​
allow_auto_assign
boolean

If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team

Example:

true

Response

Success

​
id
number

The ID of the team

​
name
string

The name of the team

​
description
string

The description about the team

​
allow_auto_assign
boolean

If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team

​
account_id
number

The ID of the account with the team is a part of

​
is_member
boolean

This field shows whether the current user is a part of the team

⌘I