Agendar mensagens pela API

Passo a passo

1. Defina o destinatário em message.to: o id do contato, o telefone ou a identidade dele.
2. Crie o agendamento:

curl -s -X POST https://http.pipebr.app/v1/schedules \
  -H "Authorization: Bearer $PIPE_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lembrete de consulta",
    "when": "2026-10-20T12:00:00.000Z",
    "message": {
      "id": "lembrete-consulta-1234",
      "to": "+5511955550101",
      "type": "text/plain",
      "content": "Lembrete: sua consulta é amanhã às 9h."
    }
  }'

1. A resposta é 201 (novo) ou 200 (substituiu um agendamento com o mesmo id):

{
  "id": "lembrete-consulta-1234",
  "name": "Lembrete de consulta",
  "contactId": "b3a1c9de-0000-4000-8000-000000000010",
  "when": "2026-10-20T12:00:00.000Z",
  "status": "scheduled",
  "message": {
    "id": "lembrete-consulta-1234",
    "to": "b3a1c9de-0000-4000-8000-000000000010",
    "type": "text/plain",
    "content": "Lembrete: sua consulta é amanhã às 9h."
  },
  "createdAt": "2026-10-12T14:30:00.000Z",
  "executedAt": null
}

1. Para agendar um modelo, use o formato de modelo do WhatsApp:

{
  "when": "2026-10-20T12:00:00.000Z",
  "message": {
    "to": "+5511955550101",
    "type": "application/json",
    "content": {
      "type": "template",
      "template": {
        "name": "lembrete_consulta",
        "language": { "code": "pt_BR" },
        "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "Maria" } ] } ]
      }
    }
  }
}

Só os parâmetros de texto do corpo são usados.