/dealsCrear negociación
Crea una negociación para un contacto en un embudo.
POST https://api.getincloud.ai/v1/dealsCrea una negociación para un contacto en un embudo.
Solo puede existir una negociación abierta por contacto y embudo: la comprobación abarca la equivalencia de identidad @c.us/@lid, por lo que la misma persona no puede tener negociaciones duplicadas bajo IDs de WhatsApp gemelos.
Un embudo archivado no admite nuevas negociaciones (409): las que ya tiene siguen siendo legibles y aún se pueden mover y cerrar, pero el trabajo nuevo debe ir a un embudo activo o hay que restaurar primero el archivado.
Nota: este recurso de la API está disponible en la suscripción Platform Professional y superiores.
Prueba este endpoint en el probador de API en vivo
>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.
Autenticación
Envía tu API key en el encabezado Token en cada petición.
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
pipeline | string | Sí | ID único del embudo al que pertenece la negociación. Obligatorio minLength: 24 · maxLength: 24 · pattern: ^[0-9A-Fa-f]{24}$ |
device | string | Sí | ID del dispositivo (número de WhatsApp) al que pertenece la negociación. Obligatorio minLength: 24 · maxLength: 24 · pattern: ^[0-9A-Fa-f]{24}$ |
stage | string | No | ID de la etapa inicial. Por defecto, la primera etapa abierta del embudo minLength: 24 · maxLength: 24 · pattern: ^[0-9A-Fa-f]{24}$ |
contactWid | string | Sí | ID de WhatsApp del contacto al que pertenece la negociación. Obligatorio minLength: 5 · maxLength: 50 · pattern: @(c\.us |
chatWid | string | No | ID de WhatsApp del chat desde el que se creó la negociación. Opcional minLength: 5 · maxLength: 50 · pattern: @(c\.us |
title | string | No | Título de la negociación. Por defecto, el nombre del contacto minLength: 1 · maxLength: 120 |
amount | number | No | Valor monetario de la negociación. Opcional minimum: 0 · maximum: 999999999 · format: float |
currency | string | No | Código de moneda ISO 4217. Por defecto, la moneda del embudo minLength: 3 · maxLength: 3 |
agent | string | No | ID del usuario agente asignado a la negociación minLength: 24 · maxLength: 24 · pattern: ^[0-9A-Fa-f]{24}$ |
department | string | No | ID del departamento asignado a la negociación minLength: 24 · maxLength: 24 · pattern: ^[0-9A-Fa-f]{24}$ |
card | object | No | Semilla de la tarjeta solo para visualización. El trabajo de conciliación la mantiene actualizada y nunca se usa para tomar decisiones |
card.name | string | No | Nombre visible del contacto minLength: 1 · maxLength: 120 |
card.phone | string | No | Número de teléfono del contacto minLength: 1 · maxLength: 30 |
card.avatarUrl | string | No | URL del avatar del contacto maxLength: 500 |
Respuestas
| Código | Descripción |
|---|---|
200 | Negociación creada |
400 | Carga útil de la negociación no válida |
401 | No autorizado: token de API no válido o ausente |
403 | Operación no admitida: se requiere actualizar el plan |
404 | Dispositivo o embudo no encontrado |
409 | Ya existe una negociación abierta para este contacto, o el embudo está archivado y no admite nuevas negociaciones |
429 | Demasiadas solicitudes: inténtalo de nuevo más tarde |
500 | Error inesperado |
501 | No implementado |
503 | Servicio no disponible temporalmente: inténtalo de nuevo más tarde |