Introducción

¿Qué puedes hacer?

Contactos: listar, buscar, crear y actualizar contactos de tu CRM
Conversaciones: listar conversaciones, consultar su estado y abrir nuevas
Mensajes: enviar mensajes de texto y multimedia al canal de cada conversación (WhatsApp, Instagram, Facebook, widget web)
Plantillas: enviar mensajes con plantillas HSM (o texto libre en canales sin plantillas Meta)
Agente IA: activar o pausar el agente IA de una conversación específica
Webhooks salientes: recibir en tu servidor eventos en tiempo real (mensaje recibido, conversación creada, etc.)
Webhooks entrantes: disparar acciones en Yolani desde sistemas externos

https://api.yolani.co/api/v1

Plan con API habilitada (plan Escala, o habilitación directa por el equipo de Yolani)
API key creada desde el Dashboard: Canales > API de Yolani, o Configuración > API Keys
Al menos un canal de mensajes conectado si vas a enviar mensajes

Método	Endpoint	Descripción
GET	`/v1/me`	Verifica tu API key y devuelve datos de tu empresa
GET	`/v1/contacts`	Lista contactos (búsqueda y paginación)
POST	`/v1/contacts`	Crea o actualiza un contacto (upsert)
GET	`/v1/contacts/:id`	Consulta un contacto
PATCH	`/v1/contacts/:id`	Actualiza un contacto
GET	`/v1/conversations`	Lista conversaciones (filtros por estado, canal, contacto)
POST	`/v1/conversations`	Abre (o reactiva) una conversación por teléfono
GET	`/v1/conversations/:id`	Consulta una conversación
PATCH	`/v1/conversations/:id`	Cambia el estado (activa, en espera, resuelta)
GET	`/v1/conversations/:id/messages`	Lista mensajes de una conversación
POST	`/v1/conversations/:id/messages`	Envía un mensaje (texto o multimedia)
GET	`/v1/templates`	Lista plantillas aprobadas (WhatsApp Business API)
POST	`/v1/conversations/:id/messages/template`	Envía una plantilla (o fallback de texto)
POST	`/v1/conversations/:id/bot`	Activa o pausa el agente IA
GET	`/v1/webhooks/event-types`	Catálogo de eventos webhook disponibles

Todas las respuestas son JSON con esta estructura:

{
  "success": true,
  "data": { },
  "meta": { "total": 120, "limit": 50, "offset": 0 }
}

Y los errores:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "phone o email requerido"
  }
}

Puedes descargar la especificación completa en formato OpenAPI 3.1: