Recaudo Docs

Conversaciones

Seguimientos

Programa y gestiona tareas de seguimiento con tus clientes

Listar seguimientos

GET /v1/follow-ups

Regresa una lista paginada de seguimientos. Puedes filtrar por estado, tipo, agente o cliente.

Campo Tipo Requerido Descripción
statusstringNoFiltrar por estado: pending, completed, overdue
typestringNoFiltrar por tipo: call, message, whatsapp, email, meeting, task
user_iduuidNoFiltrar por agente asignado
customer_iduuidNoFiltrar por cliente
limitintegerNoResultados por página (20 por defecto)
Ejemplo de petición
curl https://recaudo.app/api/v1/follow-ups?status=pending \
  -H "Authorization: Bearer sk_live_tu_secret_key" \
  -H "Content-Type: application/json"
Respuesta
{
  "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
}

Crear seguimiento

POST /v1/follow-ups
Campo Tipo Requerido Descripción
titlestringSíTítulo del seguimiento (máx. 255 caracteres)
descriptionstringNoDescripción o notas adicionales
customer_iduuidNoUUID del cliente asociado
conversation_iduuidNoUUID de la conversación asociada
user_iduuidNoUUID del agente asignado
scheduled_atdatetimeSíFecha y hora programada (ISO 8601)
typestringNocall, message, whatsapp, email, meeting, task
Ejemplo de petición
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"
  }'
Respuesta — 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"
  }
}

Completar seguimiento

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

Marca un seguimiento como completado. Opcionalmente puedes agregar notas.

Campo Tipo Requerido Descripción
notesstringNoNotas sobre la resolución
Ejemplo de petición
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" }'
Respuesta
{
  "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"
  }
}

Reprogramar seguimiento

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

Cambia la fecha programada de un seguimiento pendiente.

Campo Tipo Requerido Descripción
scheduled_atdatetimeSíNueva fecha y hora programada (ISO 8601)
Ejemplo de petición
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" }'
Respuesta
{
  "object": "follow_up",
  "data": {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "title": "Llamar para confirmar pago",
    "status": "pending",
    "scheduled_at": "2026-04-12T10:00:00Z"
  }
}
¿Te sirvió esta página? Gracias por avisarnos.
Esc