Skip to main content
POST
Agendar follow-up

Authorizations

X-API-Key
string
header
required

Chave de API gerada na plataforma em Integrações → API Keys

Headers

Idempotency-Key
string

Chave opcional para evitar duplicação em retries de rede. Se a mesma chave for reenviada para o mesmo endpoint dentro de 24h, a resposta original é retornada (sem repetir o efeito colateral), com o header Idempotent-Replay: true.

Body

application/json
lead_id
string<uuid>
required

ID do lead que receberá o follow-up

config_id
string<uuid>
required

ID de uma configuração de follow-up ativa

scheduled_at
string<date-time>

Quando disparar. Se omitido, usa agora + trigger_delay_minutes da configuração.

Response

Follow-up agendado com sucesso

id
string<uuid>
lead_id
string<uuid>
config_id
string<uuid> | null
status
enum<string>

Status do follow-up agendado

Available options:
pending,
sent,
failed,
cancelled
followup_type
enum<string>
Available options:
fixed_message,
ai_objective
scheduled_at
string<date-time>

Data/hora agendada para envio

attempt_number
integer

Número da tentativa

message_sent
string | null

Mensagem enviada (preenchido após envio)

sent_at
string<date-time> | null
created_at
string<date-time>