Klivo Chat API › Application APIs

Automações

Gerencie as regras de automação da sua conta via API.

GET

Listar Automações

Retorna todas as regras de automação.

GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/automation_rules
Parâmetros de Path
account_id integer obrigatório
ID da conta.
Query Parameters
page integer
Número da página.
CURL 
curl --request GET \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/automation_rules \
  --header 'api_access_token: '
200 
{
  "payload": [
    {
      "id": 1,
      "name": "Atribuir conversas WhatsApp",
      "description": "Rota conversas do WhatsApp para a equipe de vendas",
      "event_name": "conversation_created",
      "active": true,
      "conditions": [
        {"attribute_key": "inbox_id", "operator": "equal_to", "values": [1]}
      ],
      "actions": [
        {"action_name": "assign_a_team", "action_params": [2]}
      ]
    }
  ]
}
POST

Criar Automação

Cria uma nova regra de automação.

POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/automation_rules
Parâmetros de Path
account_id integer obrigatório
ID da conta.
Body Parameters
name string obrigatório
Nome da automação.
event_name string obrigatório
Evento: conversation_created, message_created, conversation_updated.
conditions array obrigatório
Array de condições. Cada condição tem attribute_key, operator e values.
actions array obrigatório
Array de ações. Cada ação tem action_name e action_params.
active boolean
Se a regra está ativa. Padrão: false.
CURL 
curl --request POST \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/automation_rules \
  --header 'api_access_token: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Label urgente fora do horário",
  "event_name": "conversation_created",
  "conditions": [
    {"attribute_key": "created_at", "operator": "is_not_in_business_hours", "values": []}
  ],
  "actions": [
    {"action_name": "add_label", "action_params": ["fora-horario"]}
  ],
  "active": true
}'
200 
{
  "id": 2,
  "name": "Label urgente fora do horário",
  "active": true
}
DELETE

Excluir Automação

Remove uma regra de automação.

DELETE
https://chat.klivo.marketing/api/v1/accounts/{account_id}/automation_rules/{automation_rule_id}
Parâmetros de Path
account_id integer obrigatório
ID da conta.
automation_rule_id integer obrigatório
ID da automação.
CURL 
curl --request DELETE \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/automation_rules/{automation_rule_id} \
  --header 'api_access_token: '
200 
{
  "message": "Automation Rule deleted"
}