Add a new automation rule

Add a new automation rule to account

curl --location --request POST '/api/v1/accounts//automation_rules' \ --header 'Content-Type: application/json; charset=utf-8' \ --data-raw '{ "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": "conversation_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": "conversation_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": 0 }

Request

Path Params

account_id

string

required

Body Params application/json; charset=utf-8

name

string

optional

Rule name

Example:

Add label on message create event

description

string

optional

The description about the automation and actions

Example:

Add label support and sales on message create event if incoming message content contains text help

event_name

enum<string>

optional

The event when you want to execute the automation actions

Allowed values:

conversation_createdconversation_updatedmessage_created

Example:

message_created

active

boolean

optional

Enable/disable automation rule

actions

array [object]

optional

Array of actions which you want to perform when condition matches, e.g add label support if message contains content help.

conditions

array [object]

optional

Array of conditions on which conversation filter would work, e.g message content contains text help.

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

event_name

enum<string>

optional

Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)

Allowed values:

conversation_createdconversation_updatedmessage_created

Example:

message_created

name

string

optional

The name of the rule

Example:

Add label on message create event

description

string

optional

Description to give more context about the rule

Example:

Add label support and sales on message create event if incoming message content contains text help

active

boolean

optional

Enable/disable automation rule

actions

array [object]

optional

Array of actions which we perform when condition matches

conditions

array [object]

optional

Array of conditions on which conversation/message filter would work

account_id

integer

optional

Account Id

🟠403Forbidden