Conversas

Acompanhamentos

Agende e gerencie tarefas de acompanhamento com seus clientes

Listar acompanhamentos

GET /v1/follow-ups

Retorna uma lista paginada de acompanhamentos. Você pode filtrar por status, tipo, agente ou cliente.

Campo	Tipo	Obrigatório	Descrição
`status`	string	Não	Filtrar por status: pending, completed, overdue
`type`	string	Não	Filtrar por tipo: call, message, whatsapp, email, meeting, task
`user_id`	uuid	Não	Filtrar por agente atribuído
`customer_id`	uuid	Não	Filtrar por cliente
`limit`	integer	Não	Resultados por página (padrão: 20)

Exemplo de requisição

curl https://recaudo.app/api/v1/follow-ups?status=pending \
  -H "Authorization: Bearer sk_live_tu_secret_key" \
  -H "Content-Type: application/json"

Resposta

{
  "object": "list",
  "data": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "Llamar para confirmar pago",
      "description": "El cliente solicitó una llamada de seguimiento",
      "status": "pending",
      "type": "call",
      "scheduled_at": "2026-04-10T14:00:00Z",
      "completed_at": null,
      "customer": {
        "id": "uuid-del-cliente",
        "name": "Juan Pérez",
        "phone": "+5215512345678"
      },
      "user": {
        "id": "uuid-del-agente",
        "name": "María López"
      },
      "created_at": "2026-04-08T10:00:00Z",
      "updated_at": "2026-04-08T10:00:00Z"
    }
  ],
  "total": 15
}

Criar acompanhamento

POST /v1/follow-ups

Campo	Tipo	Obrigatório	Descrição
`title`	string	Sim	Título do acompanhamento (máx. 255 caracteres)
`description`	string	Não	Descrição ou notas adicionais
`customer_id`	uuid	Não	UUID do cliente associado
`conversation_id`	uuid	Não	UUID da conversa associada
`user_id`	uuid	Não	UUID do agente atribuído
`scheduled_at`	datetime	Sim	Data e hora agendadas (ISO 8601)
`type`	string	Não	call, message, whatsapp, email, meeting, task

Exemplo de requisição

curl -X POST https://recaudo.app/api/v1/follow-ups \
  -H "Authorization: Bearer sk_live_tu_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Llamar para confirmar pago",
    "description": "El cliente pidió que le llamemos el jueves",
    "customer_id": "uuid-del-cliente",
    "user_id": "uuid-del-agente",
    "scheduled_at": "2026-04-10T14:00:00Z",
    "type": "call"
  }'

Resposta — 201 Created

{
  "object": "follow_up",
  "data": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "title": "Llamar para confirmar pago",
    "description": "El cliente pidió que le llamemos el jueves",
    "status": "pending",
    "type": "call",
    "scheduled_at": "2026-04-10T14:00:00Z",
    "completed_at": null,
    "customer": {
      "id": "uuid-del-cliente",
      "name": "Juan Pérez"
    },
    "user": {
      "id": "uuid-del-agente",
      "name": "María López"
    },
    "created_at": "2026-04-08T10:00:00Z"
  }
}

Concluir acompanhamento

POST /v1/follow-ups/{'{id}'}/complete

Marca um acompanhamento como concluído. Opcionalmente, você pode adicionar notas.

Campo	Tipo	Obrigatório	Descrição
`notes`	string	Não	Notas sobre a resolução

Exemplo de requisição

curl -X POST https://recaudo.app/api/v1/follow-ups/{id}/complete \
  -H "Authorization: Bearer sk_live_tu_secret_key" \
  -H "Content-Type: application/json" \
  -d '{ "notes": "Cliente confirmó que realizará el pago mañana" }'

Resposta

{
  "object": "follow_up",
  "data": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "title": "Llamar para confirmar pago",
    "status": "completed",
    "completed_at": "2026-04-08T15:30:00Z",
    "notes": "Cliente confirmó que realizará el pago mañana"
  }
}

Reagendar acompanhamento

POST /v1/follow-ups/{'{id}'}/reschedule

Altera a data agendada de um acompanhamento pendente.

Campo	Tipo	Obrigatório	Descrição
`scheduled_at`	datetime	Sim	Nova data e hora agendadas (ISO 8601)

Exemplo de requisição

curl -X POST https://recaudo.app/api/v1/follow-ups/{id}/reschedule \
  -H "Authorization: Bearer sk_live_tu_secret_key" \
  -H "Content-Type: application/json" \
  -d '{ "scheduled_at": "2026-04-12T10:00:00Z" }'

Resposta

{
  "object": "follow_up",
  "data": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "title": "Llamar para confirmar pago",
    "status": "pending",
    "scheduled_at": "2026-04-12T10:00:00Z"
  }
}

Esta página ajudou? Obrigado por avisar.