AgentBots
Inbox API
Conversations API
Contact Labels
CSAT Survey Page
Account AgentBots
Agents
Canned Responses
Canned Response
Custom Attributes
Contacts
Automation Rule
Help Center
Conversations
Conversation Assignment
Conversation Labels
Inboxes
Integrations
Profile
Teams
Custom Filters
Automation Rule
Add a new automation rule
Automation Rule
Add a new automation rule
Add a new automation rule to account
POST
/
api
/
v1
/
accounts
/
{account_id}
/
automation_rules
curl --request POST \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/automation_rules \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{
"name": "Add label on message create event",
"description": "Add label support and sales on message create event if incoming message content contains text help",
"event_name": "message_created",
"active": true,
"actions": [
{
"action_name": "add_label",
"action_params": [
"support"
]
}
],
"conditions": [
{
"attribute_key": "content",
"filter_operator": "contains",
"query_operator": "nil",
"values": [
"help"
]
}
]
}'
{
"event_name": "message_created",
"name": "Add label on message create event",
"description": "Add label support and sales on message create event if incoming message content contains text help",
"active": true,
"actions": [
{
"action_name": "add_label",
"action_params": [
"support",
"sales"
]
}
],
"conditions": [
{
"attribute_key": "content",
"filter_operator": "contains",
"values": [
"help"
],
"query_operator": "nil"
}
],
"account_id": 123
}
Authorizations
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
The numeric ID of the account
Body
application/json
Response
200
application/json
Success
The response is of type object
.
curl --request POST \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/automation_rules \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{
"name": "Add label on message create event",
"description": "Add label support and sales on message create event if incoming message content contains text help",
"event_name": "message_created",
"active": true,
"actions": [
{
"action_name": "add_label",
"action_params": [
"support"
]
}
],
"conditions": [
{
"attribute_key": "content",
"filter_operator": "contains",
"query_operator": "nil",
"values": [
"help"
]
}
]
}'
{
"event_name": "message_created",
"name": "Add label on message create event",
"description": "Add label support and sales on message create event if incoming message content contains text help",
"active": true,
"actions": [
{
"action_name": "add_label",
"action_params": [
"support",
"sales"
]
}
],
"conditions": [
{
"attribute_key": "content",
"filter_operator": "contains",
"values": [
"help"
],
"query_operator": "nil"
}
],
"account_id": 123
}