Pular para o conteúdo principal
POST
/
backend
/
cadences
curl -X POST "https://api.leavo.ai/backend/cadences" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Follow-up 7 dias",
    "description": "Sequência de acompanhamento",
    "steps": [
      {
        "name": "Dia 1 - Introdução",
        "order": 1,
        "interval": "P1D",
        "messages": [
          {
            "type": "text",
            "content": "Olá {{LEAD_FIRSTNAME}}! Tudo bem?",
            "delay": 0
          }
        ]
      },
      {
        "name": "Dia 3 - Follow-up",
        "order": 2,
        "interval": "P2D",
        "messages": [
          {
            "type": "text",
            "content": "{{LEAD_FIRSTNAME}}, conseguiu avaliar nossa proposta?"
          }
        ]
      },
      {
        "name": "Dia 7 - Última tentativa",
        "order": 3,
        "interval": "P4D",
        "messages": [
          {
            "type": "text",
            "content": "{{LEAD_FIRSTNAME}}, ainda temos interesse em ajudar você!"
          }
        ]
      }
    ],
    "delivery_config": {
      "day_windows": {
        "1": {"start_hour": 9, "end_hour": 18},
        "2": {"start_hour": 9, "end_hour": 18},
        "3": {"start_hour": 9, "end_hour": 18},
        "4": {"start_hour": 9, "end_hour": 18},
        "5": {"start_hour": 9, "end_hour": 18}
      },
      "time_zone": "America/Sao_Paulo"
    },
    "rate_limit": {
      "enabled": true,
      "limit_type": "daily",
      "max_leads": 100
    }
  }'
{
  "id": "uuid",
  "tenant_id": "uuid",
  "name": "Follow-up 7 dias",
  "description": "Sequência de acompanhamento",
  "is_active": false,
  "steps": [...],
  "delivery_config": {...},
  "rate_limit": {...},
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Request Body

name
string
obrigatório
Nome da cadência
description
string
Descrição da cadência
steps
array
obrigatório
Lista de etapas da cadência
delivery_config
object
Configuração de janelas de envio
rate_limit
object
Configuração de limite de envios
curl -X POST "https://api.leavo.ai/backend/cadences" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Follow-up 7 dias",
    "description": "Sequência de acompanhamento",
    "steps": [
      {
        "name": "Dia 1 - Introdução",
        "order": 1,
        "interval": "P1D",
        "messages": [
          {
            "type": "text",
            "content": "Olá {{LEAD_FIRSTNAME}}! Tudo bem?",
            "delay": 0
          }
        ]
      },
      {
        "name": "Dia 3 - Follow-up",
        "order": 2,
        "interval": "P2D",
        "messages": [
          {
            "type": "text",
            "content": "{{LEAD_FIRSTNAME}}, conseguiu avaliar nossa proposta?"
          }
        ]
      },
      {
        "name": "Dia 7 - Última tentativa",
        "order": 3,
        "interval": "P4D",
        "messages": [
          {
            "type": "text",
            "content": "{{LEAD_FIRSTNAME}}, ainda temos interesse em ajudar você!"
          }
        ]
      }
    ],
    "delivery_config": {
      "day_windows": {
        "1": {"start_hour": 9, "end_hour": 18},
        "2": {"start_hour": 9, "end_hour": 18},
        "3": {"start_hour": 9, "end_hour": 18},
        "4": {"start_hour": 9, "end_hour": 18},
        "5": {"start_hour": 9, "end_hour": 18}
      },
      "time_zone": "America/Sao_Paulo"
    },
    "rate_limit": {
      "enabled": true,
      "limit_type": "daily",
      "max_leads": 100
    }
  }'
{
  "id": "uuid",
  "tenant_id": "uuid",
  "name": "Follow-up 7 dias",
  "description": "Sequência de acompanhamento",
  "is_active": false,
  "steps": [...],
  "delivery_config": {...},
  "rate_limit": {...},
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Intervalos (ISO 8601)

ValorSignificado
P0DImediatamente
P1D1 dia
P2D2 dias
P1W1 semana
PT1H1 hora
PT30M30 minutos

Janelas de Envio

Os números das chaves em day_windows representam dias da semana:
  • 1 = Segunda-feira
  • 2 = Terça-feira
  • 3 = Quarta-feira
  • 4 = Quinta-feira
  • 5 = Sexta-feira
  • 6 = Sábado
  • 0 = Domingo
Mensagens agendadas fora das janelas de envio serão enviadas no próximo horário disponível.