List all automation rules in an account

GET

/api/v1/accounts/{account_id}/automation_rules

Automation Rule

Get details of automation rules in an Account

Response Example

200 - Example 1

[
    {
        "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

integer

required

The numeric ID of the account

Query Params

page

integer

optional

The page parameter

Default:

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

Array of all automation rules

array of:

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

Get Contactable Inboxes

Add a new automation rule