Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
canned_responses
Add a New Canned Response
curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/canned_responses \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "content": "Hello, {{contact.name}}! Welcome to our service.",
  "short_code": "welcome"
}
'
{
  "id": 123,
  "account_id": 123,
  "short_code": "<string>",
  "content": "<string>",
  "created_at": "<string>",
  "updated_at": "<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

application/json
​
content
string

Message content for canned response

Example:

"Hello, {{contact.name}}! Welcome to our service."

​
short_code
string

Short Code for quick access of the canned response

Example:

"welcome"

Response

Success

​
id
integer

ID of the canned response

​
account_id
integer

Account Id

​
short_code
string

Short Code for quick access of the canned response

​
content
string

Message content for canned response

​
created_at
string

The date and time when the canned response was created

​
updated_at
string

The date and time when the canned response was updated