API de Wrap
Contactos, empresas, conversaciones, negocios, notas, recordatorios y nueve reportes.
Base: https://wrap.eel.software/api/public/v1
Es la superficie más grande de la suite: se puede llevar un CRM entero desde fuera. Todas las rutas siguen las reglas comunes.
Contactos y empresas
| Método | Ruta | Permiso |
|---|---|---|
GET |
/contacts |
wrap:contacts:read |
POST |
/contacts |
wrap:contacts:write |
GET |
/contacts/{id} |
wrap:contacts:read |
PATCH |
/contacts/{id} |
wrap:contacts:write |
GET |
/companies |
wrap:contacts:read |
POST |
/companies |
wrap:contacts:write |
GET |
/companies/{id} |
wrap:contacts:read |
PATCH |
/companies/{id} |
wrap:contacts:write |
La lista trae los contactos vivos, es decir sin archivar y sin eliminar, del más nuevo al más viejo. El detalle de uno trae más campos que la fila de la lista.
Un contacto necesita al menos un nombre, un correo o un teléfono. Las empresas llevan nombre único en el espacio, dominio y NIT.
Conversaciones
| Método | Ruta | Permiso |
|---|---|---|
GET |
/conversations |
wrap:conversations:read |
GET |
/conversations/{id} |
wrap:conversations:read |
PATCH |
/conversations/{id} |
wrap:conversations:write |
GET |
/conversations/{id}/messages |
wrap:conversations:read |
El PATCH es lo que deja asignar, cerrar, pausar o reabrir un hilo desde fuera.
Los mensajes vienen del más nuevo al más viejo, al revés que casi todo lo demás. Lo que casi siempre necesitas es lo último dicho, y desde ahí paginar hacia atrás.
No se pueden enviar mensajes por esta API. Escribirle a un cliente pasa por las ventanas de mensajería, las plantillas y el consentimiento, y eso vive dentro de la aplicación.
Negocios
| Método | Ruta | Permiso |
|---|---|---|
GET |
/deals |
wrap:deals:read |
POST |
/deals |
wrap:deals:write |
GET |
/deals/{id} |
wrap:deals:read |
PATCH |
/deals/{id} |
wrap:deals:write |
GET |
/deal-stages |
wrap:deals:read |
/deal-stages devuelve el embudo en el orden del tablero, que es lo que hace
falta para mover un negocio: el PATCH recibe el identificador de la etapa, no
su nombre.
Notas, recordatorios y vínculos
| Método | Ruta | Permiso |
|---|---|---|
GET |
/notes |
wrap:notes:write |
POST |
/notes |
wrap:notes:write |
GET |
/follow-ups |
wrap:follow-ups:write |
POST |
/follow-ups |
wrap:follow-ups:write |
GET |
/links |
wrap:links:write |
POST |
/links |
wrap:links:write y flow:partners:write |
Ojo con los permisos: leer notas y recordatorios exige el permiso de escritura, porque no existe uno de lectura para ellos. Una credencial que solo necesita mirarlos queda también habilitada para crearlos.
/links declara que un contacto o una empresa de Wrap es un tercero de Flow.
Crear un vínculo necesita los dos permisos en la misma credencial.
Reportes
Nueve proyecciones, todas GET y todas con wrap:reports:read:
| Método | Ruta | Qué responde |
|---|---|---|
GET |
/reports/pipeline |
Conteo y valor por etapa |
GET |
/reports/volume |
Conversaciones abiertas, cerradas y reabiertas |
GET |
/reports/sla |
Tiempo hasta la primera respuesta |
GET |
/reports/agent-activity |
Mensajes, cierres y asignaciones por persona |
GET |
/reports/lost-reasons |
Negocios perdidos agrupados por motivo |
GET |
/reports/segments |
Contactos nuevos e ingresos por etiqueta o campo |
GET |
/reports/segment-dimensions |
Qué valores acepta dimension |
GET |
/reports/inbox-snapshot |
La bandeja ahora mismo |
GET |
/reports/top-contacts |
Clientes ordenados por negocios abiertos |
Consulta primero /reports/segment-dimensions: es la lista de agrupaciones
válidas, y evita adivinar.
Los rangos de fecha tienen un máximo de 92 días. Pedir un rango más largo devuelve un error que lo dice.