128:T6b9,**Permiso requerido:** `conversations:read` Devuelve un mensaje de tu cuenta por el id que te dio el envío o un webhook. Aceptado no es entregado: el estado final llega por `message.status_changed` o por este GET. `status` es `queued`, `sent`, `delivered`, `read` o `failed` en los mensajes que enviaste. `sent`, `delivered`, `read` y `failed` tienen el mismo significado que en `message.status_changed`; `queued` es un mensaje en cola que todavía no se envió (en cola no es enviado) y no se reintenta. `status` es `null` en los mensajes recibidos, las notas y las acciones. `status` también es `null` en un mensaje enviado cuyo resultado no se conoce (el proveedor no confirmó ni rechazó el envío o el envío se interrumpió): puede haber llegado y no cambia de estado; también cuando lleva más de una hora en cola sin resultado: un mensaje cuyo envío no empezó dentro de la hora ya no sale; pasada la hora sin resultado, `status` es `null`, o `failed` con `error.reason` `not_sent` y su aviso si su envío llega tarde. Reintentar es un envío nuevo, que sólo puede duplicar si el envío había empezado y se cortó. `error` trae `code`, `title` y `reason` solo cuando `status` es `failed`. `error.reason` es `null` cuando el rechazo lo informó el proveedor; si Funnelchat decidió que un mensaje enviado con clave no salía, trae `device_unavailable`, `insufficient_balance`, `window_closed`, `recipient_unreachable`, `template_not_found`, `template_unresolved_placeholder`, `not_queued` o `not_sent`, `code` es `null` y `title` es un texto llano en el idioma de la cuenta. `client_reference` es la referencia que mandaste al enviar, o `null`. Responde 404 si el mensaje no existe o no es de ese contacto.129:T7da,**Permiso requerido:** `conversations:send` Envía a un contacto un formulario de WhatsApp publicado. `form_id` es el identificador estable del formulario (el mismo en todas sus versiones) y `device_id` el número de WhatsApp Cloud de tu cuenta por el que sale. `text` (hasta 1024 caracteres) acompaña al formulario y por defecto es su nombre; `button_text` (hasta 30 caracteres, sin emojis) es el botón y por defecto es «Abrir» u «Open» según el idioma del usuario de la clave (en inglés «Open»; en español y portugués «Abrir»). Sólo funciona dentro de las 24 horas siguientes al último mensaje del contacto a ese número. Responde `200` con el mensaje en cola (`status` `queued`, `type` `whatsapp_form`); aceptado no es entregado: el estado final llega por `message.status_changed` o por `GET /contacts/{contact}/messages/{message}`, y la respuesta del contacto por `whatsapp_form.completed`. Responde `404` si el contacto no existe o no es de tu cuenta, o `404` con `form_not_found` si el formulario no existe en tu cuenta. Responde `422` con `device_unavailable` si el número no es de tu cuenta o no está conectado, `number_not_eligible` si no es un número de WhatsApp Cloud que pueda enviar formularios, `form_not_published` si el formulario no tiene versión publicada, `form_not_on_number` si no está publicado en ese número, `recipient_unreachable` si el contacto no tiene teléfono ni identificador de WhatsApp y `window_closed` si pasaron más de 24 horas. También responde `422` por las guardas de envío y `429` con `rate_limited` si superas el ritmo del número o del contacto. Si tu cuenta está bloqueada por el límite de contactos activos, responde `429` con `mac_lockout_24h` (además del `429` `rate_limited` del ritmo) y no guarda ningún mensaje ni `client_reference`. Si Funnelchat no pudo poner el mensaje en cola, la respuesta no es un error: es `200` con el mensaje en estado `failed` y `error.reason` `not_queued`; no salió, así que reintentar no lo duplica.12a:Tb92,Cambió el estado de entrega de un mensaje enviado. Se emite cuando cambia el estado de entrega de un mensaje que enviaste a un contacto, ya sea desde el chat, una automatización o un asistente de IA (incluye los enviados con clave). No se emite para mensajes de difusiones ni para mensajes recibidos. `message_id` es el id que devuelve la API, `contact_id` el del contacto y `device_id` el número de tu cuenta por el que salió el mensaje, el mismo `device_id` que usas para enviar (`null` si no tiene). `status` es `sent`, `delivered`, `read` o `failed`. `previous_status` es el estado que el mensaje tenía justo antes de este cambio y es `null` en tres casos: es el primer aviso del mensaje, es el mismo estado que `status` (por ejemplo, el proveedor confirma el `sent` que ya registró el envío) o no se pudo leer. `error` solo viene cuando `status` es `failed`: `code` es el código numérico del proveedor y `title` su título, y cualquiera de los dos puede ser `null` si el proveedor no los informa. `error.reason` es `null` cuando el fallo lo informó el proveedor; cuando Funnelchat decidió que un mensaje enviado con clave no salía (por ejemplo, por saldo insuficiente o ventana de 24 horas cerrada) trae el motivo (`device_unavailable`, `insufficient_balance`, `window_closed`, `recipient_unreachable`, `template_not_found`, `template_unresolved_placeholder`, `not_queued` o `not_sent`), `code` es `null` y `title` es un texto llano en el idioma de la cuenta. `occurred_at` es el momento en que Funnelchat registró el estado, en UTC. `client_reference` es la referencia que mandaste al enviar el mensaje (por ejemplo `pedido-1001`) y `null` si el envío no la llevaba: sirve para relacionar cada aviso con tu envío también cuando la llamada de envío no respondió. Cada estado se informa una sola vez por mensaje: si llegan varios avisos juntos se informa el más avanzado y un aviso atrasado que no cambia el estado no genera evento. Un mensaje que no llegó a salir (por ejemplo, por ventana de 24 horas cerrada) no recibe avisos de estado, salvo uno enviado con clave: ese recibe un único aviso `failed` con `previous_status` en `null`, su `error.reason` y su `client_reference`. Un mensaje enviado con clave cuyo resultado no se conoce (el proveedor no respondió o el envío se interrumpió) no recibe aviso. Un mensaje cuyo envío no empezó dentro de la hora ya no sale: pasada la hora sin resultado, su estado es `null`, o `failed` con `error.reason` `not_sent` y su aviso si su envío llega tarde. Reintentar es un envío nuevo, que sólo puede duplicar si el envío había empezado y se cortó. Un mensaje `queued` no es enviado: su resultado llega por este evento o por la consulta del mensaje. En cuentas con mucho tráfico, los eventos que excedan el límite de entrega por minuto de la cuenta se descartan. Para recibirlo debes suscribirte a `message.status_changed` de forma explícita: una suscripción a `*` no lo incluye.12b:T520,Un contacto completó un formulario de WhatsApp. Se envía cuando un contacto completa un formulario, aunque la respuesta llegue tarde. Puede llegar más de una vez con el mismo `id`: deduplica por `id`. Si el contacto vuelve a enviar el mismo formulario, no se genera otro aviso: queda la primera respuesta. Cada respuesta de texto llega con a lo sumo 600 caracteres. `form.id` es el formulario (el mismo `family_id` de la lectura de formularios) y `form.version_id` la versión que recibió el contacto. `answers` es una lista con una entrada por pregunta, en el orden del formulario: `key` es el nombre de la pregunta, `label` su etiqueta y `value` la respuesta (texto, número, `true` o `false`, una lista de textos en opción múltiple, o `null` si no la contestó). En las preguntas de lista y de opción múltiple, `value` es el id de la opción. `message_id` es el id del mensaje del formulario y es `null` si el envío no tuvo un mensaje público; `device_id` es el número de WhatsApp por el que salió, o `null` si ya no es de la cuenta. `contact_id` es `null` si el contacto se eliminó antes de que saliera el aviso (las respuestas llegan igual); si se fusionó con otro, es el id del contacto que quedó. Mientras se fusionan dos contactos, el id puede ser el del contacto que se está fusionando.118:["$","$L120",null,{"toc":[],"full":true,"children":[["$","$L121",null,{"children":"conversation.closed"}],["$","$L122",null,{"className":"mb-0","children":"Lo envía el área conversaciones: suscribite en Webhooks › Suscripciones › Suscripciones de webhooks."}],["$","div",null,{"className":"flex flex-row gap-2 items-center border-b pb-6","children":[["$","$L123",null,{"markdownUrl":"/llms.mdx/docs/webhooks/eventos/conversaciones/conversation-closed/content.md"}],["$","$L124",null,{"markdownUrl":"/llms.mdx/docs/webhooks/eventos/conversaciones/conversation-closed/content.md"}]]}],["$","$L125",null,{"children":["$undefined",["$","$L126",null,{"document":"./public/specs/conversations.anotada.json","webhooks":[{"name":"conversation.closed","method":"post"}],"showDescription":true,"preloaded":{"docs":{"./public/specs/conversations.anotada.json":{"openapi":"3.2.0","info":{"title":"Funnelchat Conversations","version":"0.0.1","description":"$127"},"servers":[{"url":"https://api.funnelchat.com/api/v1"}],"security":[{"http":[]}],"paths":{"/broadcasts":{"get":{"operationId":"broadcast.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar difusiones","tags":["Broadcast"],"parameters":[{"name":"name","in":"query","schema":{"type":["string","null"]}},{"name":"device_id","in":"query","schema":{"type":["integer","null"]}},{"name":"status[]","in":"query","schema":{"type":"array","enum":["0","1","2","3","4","5","6","7","8","9"],"items":{"type":"string","enum":["0","1","2","3","4","5","6","7","8","9"]}}},{"name":"folder_id","in":"query","schema":{"type":["integer","null"]}},{"name":"unclassified","in":"query","schema":{"type":["string","null"]}},{"name":"send_type","in":"query","schema":{"type":["string","null"],"enum":["immediate","scheduled",null]}},{"name":"device_type","in":"query","schema":{"type":["string","null"],"enum":["business","api",null]}},{"name":"send_at_from","in":"query","schema":{"type":["string","null"],"format":"date-time"}},{"name":"send_at_to","in":"query","schema":{"type":["string","null"],"format":"date-time"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","created_at","updated_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastsResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para armar un panel o reporte de tus difusiones: filtrá por número, estado, carpeta, tipo de envío o fecha programada y ubicá rápido la que te interesa."}},"/broadcasts/contacts":{"post":{"operationId":"broadcast.contacts","description":"**Permiso requerido:** `conversations:write`","summary":"Buscar contactos para una difusión","tags":["Broadcast"],"parameters":[{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"some_tags":{"type":"array","items":{"type":"string"}},"exclude_tags":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"type":"string"}},"date_from":{"type":["string","null"],"format":"date-time"},"date_to":{"type":["string","null"],"format":"date-time"},"only_with_phone":{"type":"boolean"},"only_paused":{"type":"boolean"},"kanban_setting_id":{"type":["integer","null"]},"kanban_stage_ids":{"type":["array","null"],"items":{"type":"integer"}},"only_stagnant":{"type":["boolean","null"]},"exclude_never_replied":{"type":"boolean"},"lead_score_categories":{"type":["array","null"],"items":{"type":"string","enum":["insufficient_data","hot","warm","cold"]}},"lead_score_min":{"type":["integer","null"],"minimum":0,"maximum":100},"lead_score_max":{"type":["integer","null"],"minimum":0,"maximum":100},"per_page":{"type":["integer","null"],"minimum":1}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastContactResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para previsualizar la audiencia de una difusión antes de crearla: le pasás los filtros (etiquetas, países, etapa del kanban, lead score) y te devuelve, paginados, los contactos que entrarían."}},"/broadcasts/contacts-count":{"post":{"operationId":"broadcast.contactsCount","description":"**Permiso requerido:** `conversations:write`","summary":"Contar contactos para una difusión","tags":["Broadcast"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"some_tags":{"type":"array","items":{"type":"string"}},"exclude_tags":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"type":"string"}},"date_from":{"type":["string","null"],"format":"date-time"},"date_to":{"type":["string","null"],"format":"date-time"},"only_with_phone":{"type":"boolean"},"only_paused":{"type":"boolean"},"kanban_setting_id":{"type":["integer","null"]},"kanban_stage_ids":{"type":["array","null"],"items":{"type":"integer"}},"only_stagnant":{"type":["boolean","null"]},"exclude_never_replied":{"type":"boolean"},"lead_score_categories":{"type":["array","null"],"items":{"type":"string","enum":["insufficient_data","hot","warm","cold"]}},"lead_score_min":{"type":["integer","null"],"minimum":0,"maximum":100},"lead_score_max":{"type":["integer","null"],"minimum":0,"maximum":100}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"contactsCount":{"type":"integer"},"unreachableCount":{"type":"integer"},"pausedCount":{"type":"integer"},"optedOutCount":{"type":"integer"}},"required":["contactsCount","unreachableCount","pausedCount","optedOutCount"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para dimensionar una difusión antes de lanzarla: con los mismos filtros de segmentación te dice cuántos contactos entran, cuántos no son alcanzables y cuántos están pausados."}},"/broadcasts/cost-tiers":{"get":{"operationId":"broadcast.costTiers","description":"**Permiso requerido:** `conversations:read`","summary":"Ver los tramos de costo","tags":["Broadcast"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastCostTiersResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para consultar los tramos de costo vigentes y la fecha de la última actualización de tarifas, como referencia para estimar cuánto puede costar una difusión."}},"/broadcasts/move-to-folder":{"post":{"operationId":"broadcast.moveToFolder","description":"**Permiso requerido:** `conversations:write`","summary":"Mover difusiones a una carpeta","tags":["Broadcast"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveBroadcastsToFolderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"moved":{"type":"integer","minimum":0}},"required":["moved"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para ordenar difusiones en bloque: mové varias a una carpeta con una sola llamada, por ejemplo al agruparlas por campaña o por cliente."}},"/broadcasts/{broadcast}":{"get":{"operationId":"broadcast.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver una difusión","tags":["Broadcast"],"parameters":[{"name":"broadcast","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"No tienes permiso para ver este broadcast."}},"required":["message"]}}}},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para ver la configuración completa de una difusión: número, plantilla, carpeta y los filtros de audiencia que usó (etiquetas, países, kanban, lead score)."},"delete":{"operationId":"broadcast.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar una difusión","tags":["Broadcast"],"parameters":[{"name":"broadcast","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"No tienes permiso para eliminar este broadcast."}},"required":["message"]}}}},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Las campañas que ya fueron enviadas o están saliendo no pueden eliminarse."},"error_code":{"type":"string","const":"broadcast_delete_not_allowed"}},"required":["message","error_code"]}}}}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para quitar de tu cuenta una difusión que ya no necesitás. Si lo que querés es frenar un envío, mirá la operación de cancelar."}},"/broadcasts/{broadcast}/statistics":{"get":{"operationId":"broadcast.statistics","description":"**Permiso requerido:** `conversations:read`","summary":"Ver las estadísticas de una difusión","tags":["Broadcast"],"parameters":[{"name":"broadcast","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"broadcast_id":{"type":"integer"},"statistics":{"type":"object","properties":{"delivered_messages_count":{"type":"integer"},"readed_messages_count":{"type":"integer"},"failed_messages_count":{"type":"integer"},"pending_messages_count":{},"replied_messages_count":{"type":"integer"},"skipped_messages_count":{"type":"number"},"skipped_by_reason":{"type":"object","additionalProperties":{"type":"string"}}},"required":["delivered_messages_count","readed_messages_count","failed_messages_count","pending_messages_count","replied_messages_count","skipped_messages_count","skipped_by_reason"]},"button_interactions":{"type":"array","items":{"type":"object","properties":{"button_index":{"type":"integer"},"clicks_count":{"type":"integer"}},"required":["button_index","clicks_count"]}}},"required":["broadcast_id","statistics","button_interactions"]},{"type":"object","properties":{"broadcast_id":{"type":"integer"},"statistics":{"type":"object","properties":{"delivered_messages_count":{"anyOf":[{"type":"string"},{"type":"integer","enum":[0]}]},"readed_messages_count":{"anyOf":[{"type":"string"},{"type":"integer","enum":[0]}]},"failed_messages_count":{"anyOf":[{"type":"string"},{"type":"integer","enum":[0]}]},"pending_messages_count":{},"replied_messages_count":{"type":"integer"},"skipped_messages_count":{"type":"number"},"skipped_by_reason":{"type":"object","additionalProperties":{"type":"string"}}},"required":["delivered_messages_count","readed_messages_count","failed_messages_count","pending_messages_count","replied_messages_count","skipped_messages_count","skipped_by_reason"]},"button_interactions":{"type":"array","items":{"type":"object","properties":{"button_index":{"type":"integer"},"clicks_count":{"type":"integer"}},"required":["button_index","clicks_count"]}}},"required":["broadcast_id","statistics","button_interactions"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para medir el resultado de una difusión: entregados, leídos, respondidos, fallidos, pendientes y omitidos (con su motivo), más los clics en cada botón."}},"/broadcasts/{broadcast}/cost":{"get":{"operationId":"broadcast.cost","description":"**Permiso requerido:** `conversations:read`","summary":"Ver el costo de una difusión","tags":["Broadcast"],"parameters":[{"name":"broadcast","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastCostResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para saber cuánto cuesta una difusión: la estimación previa y el costo calculado de lo enviado, desglosado por mercado, con aviso de si el dato todavía es parcial."}},"/broadcasts/{broadcast}/contacts":{"get":{"operationId":"broadcast.broadcastContacts","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los contactos de una difusión","tags":["Broadcast"],"parameters":[{"name":"broadcast","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para obtener la lista de destinatarios de una difusión, por ejemplo para cruzarla con tu CRM o auditar a quién se le envió."}},"/broadcasts/{broadcast}/cancel":{"post":{"operationId":"broadcast.cancel","description":"**Permiso requerido:** `conversations:write`","summary":"Cancelar una difusión","tags":["Broadcast"],"parameters":[{"name":"broadcast","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Broadcast cancelled."}},"required":["message"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Ese envío ya fue reanudado o cancelado."},"error_code":{"type":"string","const":"smart_send_already_transitioned"}},"required":["message","error_code"]}}}}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para frenar una difusión programada o en curso antes de que siga enviando. Si ya no se puede cancelar, responde `409`."}},"/broadcasts/{broadcast}/messages":{"get":{"operationId":"broadcast.broadcastMessages","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los mensajes de una difusión","tags":["Broadcast"],"parameters":[{"name":"broadcast","in":"path","required":true,"schema":{"type":"integer"}},{"name":"status[]","in":"query","required":true,"schema":{"type":"array","enum":["0","1","2","3","4","5","6","7","8","9","10"],"items":{"type":"string","enum":["0","1","2","3","4","5","6","7","8","9","10"]}}},{"name":"tab","in":"query","schema":{"type":["string","null"],"enum":["all","delivered","read","replied","failed","skipped",null]}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastMessageResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver el detalle por destinatario de una difusión: estado de cada mensaje, motivo de omisión y fecha de envío. Ideal para detectar fallidos o ver quién leyó o respondió."}},"/broadcasts/folders":{"get":{"operationId":"broadcastFolder.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar carpetas de difusiones","tags":["Broadcast"],"parameters":[{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastFolderResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para obtener las carpetas de difusiones con cuántas difusiones tiene cada una, por ejemplo para replicar esa organización en tu sistema."},"post":{"operationId":"broadcastFolder.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear una carpeta de difusiones","tags":["Broadcast"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreBroadcastFolderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastFolderResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para crear una carpeta y agrupar difusiones por campaña, cliente o el criterio que uses."}},"/broadcasts/folders/{broadcastFolder}":{"put":{"operationId":"broadcastFolder.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar una carpeta de difusiones","tags":["Broadcast"],"parameters":[{"name":"broadcastFolder","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBroadcastFolderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastFolderResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"You do not have permission to edit this folder."}},"required":["message"]}}}},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para renombrar una carpeta de difusiones."},"delete":{"operationId":"broadcastFolder.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar una carpeta de difusiones","tags":["Broadcast"],"parameters":[{"name":"broadcastFolder","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"You do not have permission to delete this folder."}},"required":["message"]}}}},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para eliminar una carpeta de difusiones que ya no usás."}},"/contacts":{"get":{"operationId":"contact.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar contactos","tags":["Contact"],"parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"email","in":"query","schema":{"type":"string"}},{"name":"phone","in":"query","schema":{"type":"string"}},{"name":"whatsapp_id","in":"query","schema":{"type":"string"}},{"name":"country_codes[]","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"image","in":"query","schema":{"type":"string"}},{"name":"created_at","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"created_from","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"created_to","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"tag_ids[]","in":"query","schema":{"type":"array","items":{"type":"integer"}}},{"name":"tag_mode","in":"query","schema":{"type":"string","enum":["all","any","exclude"]}},{"name":"custom_field_ids[]","in":"query","schema":{"type":"array","items":{"type":"integer"}}},{"name":"custom_field_mode","in":"query","schema":{"type":"string","enum":["all","any","exclude"]}},{"name":"custom_field_value","in":"query","schema":{"type":"string"}},{"name":"custom_field_date_from","in":"query","schema":{"type":"string","format":"date"}},{"name":"custom_field_date_to","in":"query","schema":{"type":"string","format":"date"}},{"name":"custom_field_numeric_operator","in":"query","schema":{"type":"string","enum":["lt","eq","gt"]}},{"name":"custom_field_numeric_value","in":"query","schema":{"type":"number"}},{"name":"only_with_phone","in":"query","schema":{"type":"string"}},{"name":"only_with_mac","in":"query","schema":{"type":"string"}},{"name":"scopeToAdvisor","in":"query","schema":{"type":"string"}},{"name":"lead_score_categories[]","in":"query","schema":{"type":"array","enum":["insufficient_data","hot","warm","cold"],"items":{"type":"string","enum":["insufficient_data","hot","warm","cold"]}}},{"name":"lead_score_min","in":"query","schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"lead_score_max","in":"query","schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"lead_score_disqualified","in":"query","schema":{"type":["string","null"],"enum":["include","exclude","only",null]}},{"name":"tag_filters","in":"query","schema":{"type":"array","items":{"type":"object","properties":{"mode":{"type":"string","enum":["all","any","exclude"]},"tag_ids":{"type":"array","items":{"type":"integer"}}},"required":["mode"]}},"x-deepObject-style":"qs"},{"name":"custom_field_filters","in":"query","schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"integer","enum":["0","1","2","3","4"]},"mode":{"type":["string","null"],"enum":["all","any","exclude",null]},"value":{"type":["string","null"]},"date_from":{"type":["string","null"],"format":"date"},"date_to":{"type":["string","null"],"format":"date"},"numeric_operator":{"type":["string","null"],"enum":["lt","eq","gt",null]},"numeric_value":{"type":["number","null"]},"date_operator":{"type":["string","null"],"enum":["lt","gt","eq","period",null]},"custom_field_ids":{"type":"array","items":{"type":"integer"}}},"required":["type"]}},"x-deepObject-style":"qs"},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["id","name","email","phone","status","favorite","unread_messages","created_at","updated_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para buscar y segmentar contactos desde tu sistema: filtrá por nombre, teléfono, email, etiquetas, campos personalizados, país, fecha de alta o lead score. Es la base para sincronizar o exportar tu CRM."},"post":{"operationId":"contact.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear un contacto","tags":["Contact"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreContactRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para dar de alta un contacto nuevo (teléfono o WhatsApp ID, nombre, email) cuando sabés que no existe. Si no estás seguro, usá la operación de crear o actualizar."}},"/contacts/update-or-create":{"post":{"operationId":"contact.updateOrCreate","description":"**Permiso requerido:** `conversations:write`","summary":"Crear o actualizar un contacto","tags":["Contact"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"required":["phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Contacto no encontrado."}},"required":["message"]}}}},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para sincronizar contactos desde tu sistema sin duplicarlos: si el teléfono ya existe lo actualiza, si no lo crea. Es la opción segura para reintentos."}},"/contacts/attach-custom-field":{"post":{"operationId":"contact.attachCustomField","description":"**Permiso requerido:** `conversations:write`","summary":"Asignar un campo personalizado a contactos","tags":["Contact"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer"},"contactId":{"type":"integer"},"value":{"type":"string"}},"required":["customFieldId","contactId","value"]}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"message":{"type":"string","const":"No autorizado: el campo personalizado no pertenece al usuario autenticado."},"status":{"type":"integer","const":403}},"required":["message","status"]},{"type":"object","properties":{"message":{"type":"string","const":"No autorizado: el contacto no pertenece al usuario autenticado."},"status":{"type":"integer","const":403}},"required":["message","status"]},{"type":"object","properties":{"message":{"type":"string","const":"Custom field value attached successfully."},"status":{"type":"integer","const":201}},"required":["message","status"]}]}}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para guardar datos propios de tu negocio en los contactos (plan, ciudad, fecha de compra): asigna valores de campos personalizados a uno o varios contactos en una sola llamada."}},"/contacts/detach-custom-field":{"post":{"operationId":"contact.detachCustomField","description":"**Permiso requerido:** `conversations:write`","summary":"Quitar un campo personalizado de contactos","tags":["Contact"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer"},"contactId":{"type":"integer"}},"required":["customFieldId","contactId"]}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string"}}},"required":["messages"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para borrar el valor de un campo personalizado en uno o varios contactos, por ejemplo cuando un dato quedó desactualizado en tu sistema."}},"/contacts/{contact}":{"get":{"operationId":"contact.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver un contacto","tags":["Contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ContactResource"},{"type":"object","required":["whatsapp_username","custom_fields","manually_unread","name_mismatch"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para traer la ficha completa de un contacto: datos, campos personalizados, estado de la conversación, mensajes sin leer y último mensaje."},"put":{"operationId":"contact.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar un contacto","tags":["Contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para mantener al día la ficha de un contacto desde tu sistema: nombre, email, teléfono, notas, asesor asignado, favorito o si puede ejecutar flujos."}},"/contacts/{contact}/tags":{"get":{"operationId":"contact.tags","description":"**Permiso requerido:** `conversations:read`","summary":"Listar las etiquetas de un contacto","tags":["Contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactTagResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para saber qué etiquetas tiene un contacto, por ejemplo para reflejar su segmento en tu CRM o decidir qué acción tomar."}},"/contacts/{contact}/custom-fields":{"get":{"operationId":"contact.customFields","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los campos personalizados de un contacto","tags":["Contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactCustomFieldResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para leer los valores de los campos personalizados de un contacto, con búsqueda por nombre de campo."}},"/contacts/{contact}/meta-window":{"get":{"operationId":"contact.metaWindow","description":"**Permiso requerido:** `conversations:read`","summary":"Ver la ventana de 24 horas de un contacto","tags":["Contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"device_id","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"is_open":{"type":"boolean"},"meta_device_id":{"type":"null"},"expires_at":{"type":"null"}},"required":["is_open","meta_device_id","expires_at"]},{"type":"object","properties":{"is_open":{"type":"boolean"},"meta_device_id":{"type":"null"},"expires_at":{"type":["string","null"]}},"required":["is_open","meta_device_id","expires_at"]},{"type":"object","properties":{"is_open":{"type":"boolean"},"meta_device_id":{},"expires_at":{"type":["string","null"]}},"required":["is_open","meta_device_id","expires_at"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo antes de escribirle a un contacto para saber si su ventana de 24 horas de Meta está abierta en un número, y así decidir si podés mandar un mensaje libre o necesitás una plantilla."}},"/devices/{device}/contacts":{"get":{"operationId":"contact.contactsByDevice","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los contactos de un número","tags":["Contact"],"parameters":[{"name":"device","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ContactResource"},{"type":"object","required":["whatsapp_username"]}]}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar los contactos asociados a uno de tus números conectados, útil si manejás varios números y querés separar la base por cada uno."}},"/contacts/delete":{"post":{"operationId":"contact.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar contactos","tags":["Contact"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"all":{"type":"boolean"},"contactIds":{"type":"array","items":{"type":"integer"}},"created_from":{"type":["string","null"],"format":"date-time"},"created_to":{"type":["string","null"],"format":"date-time"},"tag_mode":{"type":["string","null"],"enum":["all","any","exclude",null]},"tag_ids":{"type":["array","null"],"items":{"type":"integer"}},"tag_filters":{"type":["array","null"],"items":{"type":"object","properties":{"tag_ids":{"type":"array","items":{"type":"integer"},"minItems":1},"mode":{"type":"string","enum":["all","any","exclude"]}},"required":["tag_ids","mode"]}},"custom_field_mode":{"type":["string","null"],"enum":["all","any","exclude",null]},"custom_field_ids":{"type":["array","null"],"items":{"type":"integer"}},"custom_field_value":{"type":["string","null"]},"custom_field_date_from":{"type":["string","null"],"format":"date"},"custom_field_date_to":{"type":["string","null"],"format":"date"},"custom_field_numeric_operator":{"type":["string","null"],"enum":["lt","eq","gt",null]},"custom_field_numeric_value":{"type":["number","null"]},"custom_field_filters":{"type":["array","null"],"items":{"type":"object","properties":{"custom_field_ids":{"type":"array","items":{"type":"integer"},"minItems":1},"type":{"type":"integer","enum":["0","1","2","3","4"]},"mode":{"type":["string","null"],"enum":["all","any","exclude",null]},"value":{"type":["string","null"]},"date_from":{"type":["string","null"],"format":"date"},"date_to":{"type":["string","null"],"format":"date"},"numeric_operator":{"type":["string","null"],"enum":["lt","eq","gt",null]},"numeric_value":{"type":["number","null"]},"date_operator":{"type":["string","null"],"enum":["lt","gt","eq","period",null]}},"required":["custom_field_ids","type"]}},"country_codes":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para borrar contactos en bloque: por IDs, por filtros (etiquetas, campos personalizados, país, fecha de alta) o todos. Ideal para limpiezas masivas de la base."}},"/contacts/{contact}/pause":{"post":{"operationId":"contactAutomation.pause","description":"**Permiso requerido:** `conversations:write`","summary":"Pausar un contacto","tags":["ContactAutomation"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para pausar a un contacto en las automatizaciones de la cuenta; las conversaciones y las difusiones permiten filtrar a los contactos pausados."}},"/contacts/{contact}/flows":{"get":{"operationId":"contactAutomation.flows","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los flujos de un contacto","tags":["ContactAutomation"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactFlowListResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para saber en qué flujos de automatización está un contacto y si alguno sigue corriendo."}},"/contacts/{contact}/message/contact-card":{"post":{"operationId":"contactCard.store","description":"**Permiso requerido:** `conversations:send`","summary":"Enviar una tarjeta de contacto","tags":["ContactCard"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreContactCardRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/PublicMessageResource"}}},"required":["messages"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["window_closed","antiblock_duplicate_content","antiblock_unanswered_limit","recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["device_unavailable","not_sent"]},"message":{"type":"string"}},"required":["error","message"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","enum":["Server Error"]}},"required":["message"]}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Sirve para compartirle a un contacto una o más tarjetas de contacto desde uno de tus números, por ejemplo para pasarle el contacto de un vendedor o de soporte."}},"/contacts/{contact}/lead-score":{"get":{"operationId":"contactLeadScore.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver el lead score de un contacto","tags":["ContactLeadScore"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactLeadScoreResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para saber qué tan caliente está un lead: puntaje, categoría, confianza, si está descalificado y el historial de señales que lo explican, paginado por cursor."}},"/contacts/{contact}/notes":{"get":{"operationId":"contactNote.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar las notas de un contacto","tags":["ContactNote"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":["string","null"],"maxLength":255}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactNoteResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para leer las notas que el equipo dejó sobre un contacto, con autor y fecha, y buscar por texto."},"post":{"operationId":"contactNote.store","description":"**Permiso requerido:** `conversations:write`","summary":"Agregar una nota a un contacto","tags":["ContactNote"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreContactNoteRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactNoteResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para dejar registro en la ficha del contacto de algo que pasó en tu sistema, como una llamada, una compra o un reclamo."}},"/contacts/{contact}/notes/{note}":{"delete":{"operationId":"contactNote.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar una nota","tags":["ContactNote"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"note","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para borrar una nota de un contacto que quedó obsoleta o se cargó por error."}},"/conversations":{"get":{"operationId":"conversation.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar conversaciones","tags":["Conversation"],"parameters":[{"name":"favorites","in":"query","schema":{"type":"boolean"}},{"name":"ownContacts","in":"query","schema":{"type":"boolean"}},{"name":"ownAndUnassigned","in":"query","schema":{"type":"boolean"}},{"name":"perName","in":"query","schema":{"type":"string"}},{"name":"deviceId","in":"query","schema":{"type":"integer"}},{"name":"contactId","in":"query","schema":{"type":"integer"}},{"name":"advisorId","in":"query","schema":{"type":"integer"}},{"name":"advisorIds","in":"query","schema":{"type":"string"}},{"name":"activeConversation","in":"query","schema":{"type":"boolean"}},{"name":"tags","in":"query","schema":{"type":"string"}},{"name":"kanbanSettingId","in":"query","schema":{"type":"integer","minimum":1}},{"name":"kanbanStageIds","in":"query","schema":{"type":"string"}},{"name":"unreadMessages","in":"query","schema":{"type":"boolean"}},{"name":"onlyWithMac","in":"query","schema":{"type":"boolean"}},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"updated_since","in":"query","schema":{"type":"string"}},{"name":"paused","in":"query","schema":{"type":"string","enum":["true","false","1","0"]}},{"name":"leadScoreCategories","in":"query","schema":{"type":["string","null"]}},{"name":"leadScoreMin","in":"query","schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"leadScoreMax","in":"query","schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"leadScoreDisqualified","in":"query","schema":{"type":["string","null"],"enum":["include","exclude","only",null]}},{"name":"metaWindowOpen","in":"query","schema":{"type":"boolean"}},{"name":"metaWindowDeviceIds","in":"query","schema":{"type":["string","null"]}},{"name":"lastMessageDateFrom","in":"query","schema":{"type":["string","null"],"format":"date"}},{"name":"lastMessageDateTo","in":"query","schema":{"type":["string","null"],"format":"date"}},{"name":"timezone","in":"query","schema":{"type":["string","null"]}},{"name":"customFieldFilters","in":"query","schema":{"type":["string","null"]}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"is_mac_inactive":{"type":"boolean","description":"`true` si el contacto es inactivo por el límite de contactos activos en el momento de la consulta: tu cuenta está en bloqueo (`state` = `enforcing` en `GET /mac/status`) y el contacto todavía no es un contacto activo del ciclo actual. Viene en `GET /contacts`, `GET /contacts/{contact}` y `GET /conversations`."}},"required":["is_mac_inactive"]}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"path":{"type":"string"},"per_page":{"type":"integer"},"next_cursor":{"type":["string","null"]},"prev_cursor":{"type":["string","null"]}},"required":["path","per_page","next_cursor","prev_cursor"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","const":"No se pudieron cargar las conversaciones"}},"required":["error"]}}}}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para construir tu propia bandeja de entrada o sincronizar conversaciones: filtrá por número, asesor, etiquetas, etapa del kanban, no leídas o lead score, y traé solo lo nuevo con `updated_since`."}},"/conversations/count/unread":{"get":{"operationId":"conversation.countUnread","description":"**Permiso requerido:** `conversations:read`","summary":"Contar conversaciones sin leer","tags":["Conversation"],"parameters":[{"name":"advisorIds","in":"query","schema":{"type":"string"}},{"name":"favorites","in":"query","schema":{"type":"boolean"}},{"name":"ownAndUnassigned","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","minimum":0}},"required":["count"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para mostrar un contador de conversaciones sin leer, por ejemplo en un badge o tablero, filtrable por asesores o favoritas."}},"/conversations/count/open":{"get":{"operationId":"conversation.countOpen","description":"**Permiso requerido:** `conversations:read`","summary":"Contar conversaciones abiertas","tags":["Conversation"],"parameters":[{"name":"advisorIds","in":"query","schema":{"type":"string"}},{"name":"favorites","in":"query","schema":{"type":"boolean"}},{"name":"ownAndUnassigned","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","minimum":0}},"required":["count"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para medir la carga de trabajo actual: cuántas conversaciones abiertas hay, en total o por asesor."}},"/conversations/count/closed":{"get":{"operationId":"conversation.countClosed","description":"**Permiso requerido:** `conversations:read`","summary":"Contar conversaciones cerradas","tags":["Conversation"],"parameters":[{"name":"advisorIds","in":"query","schema":{"type":"string"}},{"name":"favorites","in":"query","schema":{"type":"boolean"}},{"name":"ownAndUnassigned","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","minimum":0}},"required":["count"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para contar las conversaciones cerradas, por ejemplo para métricas de atención por asesor."}},"/conversations/count/all":{"get":{"operationId":"conversation.countAll","description":"**Permiso requerido:** `conversations:read`","summary":"Contar todas las conversaciones","tags":["Conversation"],"parameters":[{"name":"advisorIds","in":"query","schema":{"type":"string"}},{"name":"favorites","in":"query","schema":{"type":"boolean"}},{"name":"ownAndUnassigned","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","minimum":0}},"required":["count"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para obtener el total de conversaciones, como base para calcular la proporción de abiertas, cerradas o sin leer."}},"/conversations/mark-all-read":{"post":{"operationId":"conversation.markAllAsRead","description":"**Permiso requerido:** `conversations:write`","summary":"Marcar todas como leídas","tags":["Conversation"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"advisorIds":{"type":"string"},"favorites":{"type":"boolean"},"ownAndUnassigned":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Todas las conversaciones han sido marcadas como leídas"},"updated_count":{"type":"integer"}},"required":["message","updated_count"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para poner en cero los no leídos de una vez, por ejemplo cuando ya atendiste por otro canal; se puede acotar por asesores o favoritas."}},"/conversations/mark-all-unread":{"post":{"operationId":"conversation.markAllAsUnread","description":"**Permiso requerido:** `conversations:write`","summary":"Marcar todas como no leídas","tags":["Conversation"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"advisorIds":{"type":"string"},"favorites":{"type":"boolean"},"ownAndUnassigned":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Todas las conversaciones elegibles fueron marcadas como no leídas"},"marked_count":{"type":"integer"},"limit_reached":{"type":"boolean"},"contact_ids":{"type":"object","additionalProperties":{}}},"required":["message","marked_count","limit_reached","contact_ids"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para volver a marcar como no leídas las conversaciones de un conjunto (por asesores o favoritas) y que el equipo las retome. Tiene un tope y la respuesta avisa si se alcanzó."}},"/contacts/{contact}/update":{"put":{"operationId":"conversation.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar la conversación de un contacto","tags":["Conversation"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"favorite":{"type":"boolean"},"active_conversation":{"type":"boolean"},"unread_messages":{"type":"integer"},"adviser_id":{"type":["integer","null"]},"device_id":{"type":"integer"},"text":{"type":"string"},"notes":{"type":["string","null"]},"custom_fields":{"type":"array","items":{"type":"string"}},"manually_unread":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para gestionar la conversación con un contacto: asignarla a un asesor, abrirla o cerrarla, marcarla como favorita o no leída, o cambiar el número que la atiende."}},"/contacts/{contact}/message":{"post":{"operationId":"conversation.sendMessage","description":"**Permiso requerido:** `conversations:send`","summary":"Enviar un mensaje a un contacto","tags":["Conversation"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"anyOf":[{"$ref":"#/components/schemas/PublicMessageResource"},{"type":"null"}]}},"required":["message"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["window_closed","antiblock_duplicate_content","antiblock_unanswered_limit","recipient_mismatch","recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["device_unavailable","not_sent"]},"message":{"type":"string"}},"required":["error","message"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","enum":["Server Error"]}},"required":["message"]}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Usalo para enviarle a un contacto un mensaje de texto o un archivo desde uno de tus números, con opción de responder a un mensaje previo, sumar opciones o vista previa de link."}},"/contacts/{contactId}/messages":{"get":{"operationId":"conversation.getLatestMessages","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los mensajes de un contacto","tags":["Conversation"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"updated_since","in":"query","schema":{"type":"string"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessageResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"path":{"type":"string"},"per_page":{"type":"integer"},"next_cursor":{"type":["string","null"]},"prev_cursor":{"type":["string","null"]}},"required":["path","per_page","next_cursor","prev_cursor"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para traer el historial de mensajes de un contacto y mantenerlo sincronizado en tu sistema, con paginación por cursor y `updated_since` para pedir solo lo nuevo."}},"/custom-fields":{"get":{"operationId":"customField.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar campos personalizados","tags":["CustomField"],"parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"description","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"integer"}},{"name":"withContactCount","in":"query","schema":{"type":"boolean"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","created_at","updated_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para conocer los campos personalizados de la cuenta y sus IDs antes de leer o escribir esos datos en tus contactos."},"post":{"operationId":"customField.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear un campo personalizado","tags":["CustomField"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":254},"description":{"type":["string","null"],"maxLength":1000},"type":{"type":"integer"}},"required":["name","type"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para crear un campo personalizado nuevo (por ejemplo «plan» o «fecha de compra») y guardar en Funnelchat datos propios de tu negocio."}},"/custom-fields/delete":{"post":{"operationId":"customField.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar campos personalizados","tags":["CustomField"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["customFieldIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para eliminar en bloque los campos personalizados que ya no usás."}},"/custom-fields/{customField}":{"get":{"operationId":"customField.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver un campo personalizado","tags":["CustomField"],"parameters":[{"name":"customField","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver la definición de un campo personalizado: nombre, tipo, descripción y cuántos contactos lo tienen."},"put":{"operationId":"customField.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar un campo personalizado","tags":["CustomField"],"parameters":[{"name":"customField","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":254},"description":{"type":["string","null"],"maxLength":1000}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para renombrar un campo personalizado o actualizar su descripción; el tipo no se cambia por acá."}},"/contact-flows/{contactId}":{"get":{"operationId":"flow.contactFlowHistory","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los flujos en curso de un contacto","tags":["Flow"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string","maxLength":255}},{"name":"status_group","in":"query","schema":{"type":"string","enum":["en_curso","completado","invalidado","cancelado"]}},{"name":"date_from","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"date_to","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver el historial de ejecuciones de flujos de un contacto, filtrable por estado (en curso, completado, invalidado, cancelado) y fechas. Útil para diagnosticar por qué recibió o no una automatización."}},"/contact-flows/{contactFlowId}/cancel":{"put":{"operationId":"flow.cancelContactFlow","description":"**Permiso requerido:** `conversations:write`","summary":"Cancelar un flujo en curso","tags":["Flow"],"parameters":[{"name":"contactFlowId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"contact_flow":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"integer"}},"required":["id","status"]}},"required":["contact_flow"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"No se puede cancelar esta automatización. Puede que ya haya finalizado o no exista."}},"required":["message"]}}}}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para frenar un flujo que está corriendo para un contacto, por ejemplo cuando tu sistema detecta que ya compró o pidió no recibir más mensajes."}},"/flows":{"get":{"operationId":"flow.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar flujos","tags":["Flow"],"parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"folder_id","in":"query","schema":{"type":"integer"}},{"name":"unclassified","in":"query","schema":{"type":"string"}},{"name":"trigger_type","in":"query","schema":{"type":"string","enum":["1","2","3","4","5","6","7","inbound_automation"]}},{"name":"status","in":"query","schema":{"type":"string","enum":["active","inactive"]}},{"name":"date_from","in":"query","schema":{"type":"string","format":"date"}},{"name":"date_to","in":"query","schema":{"type":"string","format":"date"}},{"name":"date_field","in":"query","schema":{"type":"string","enum":["created_at","updated_at"]}},{"name":"device_id","in":"query","schema":{"type":"string"}},{"name":"device_ids[]","in":"query","schema":{"type":"array","items":{"type":"integer","minimum":1}}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","created_at","updated_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar tus flujos de automatización con filtros por carpeta, disparador, estado, número o fecha, por ejemplo para mostrarlos en tu producto o auditarlos."}},"/flows/{flow}":{"get":{"operationId":"flow.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver un flujo","tags":["Flow"],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlowResource"},{"type":"object","required":["folder"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para ver la configuración de un flujo: si está activo y es válido, cuántas veces se ejecutó y qué lo dispara (tipo, valores y números)."}},"/flows/{flow}/nodes":{"get":{"operationId":"flow.nodes","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los nodos de un flujo","tags":["Flow"],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NodeResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para leer los nodos de un flujo y cómo se encadenan, por ejemplo para documentar o visualizar la automatización fuera de Funnelchat."}},"/flows/{flow}/active-contacts":{"get":{"operationId":"flow.activeContacts","description":"**Permiso requerido:** `conversations:read`","summary":"Contar los contactos activos de un flujo","tags":["Flow"],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"integer"}},{"name":"payment_event_type","in":"query","schema":{"type":"string","enum":["approved","pending","rejected","cancelled","refunded","chargeback"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"active_contacts_count":{"type":"integer","minimum":0}},"required":["active_contacts_count"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para saber cuántos contactos están ahora dentro de un flujo, por ejemplo antes de editarlo o desactivarlo."}},"/flows/{flow}/active-contacts-list":{"get":{"operationId":"flow.activeContactsList","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los contactos activos de un flujo","tags":["Flow"],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para saber quiénes están ahora dentro de un flujo, con búsqueda, por ejemplo para revisar casos o cancelar ejecuciones puntuales."}},"/flows/{flow}/flow-contacts":{"get":{"operationId":"flow.flowContactsList","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los contactos de un flujo","tags":["Flow"],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string","maxLength":255}},{"name":"status_group","in":"query","schema":{"type":"string","enum":["en_curso","completado","invalidado","cancelado"]}},{"name":"date_from","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"date_to","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para ver todos los contactos que pasaron por un flujo, filtrando por estado (en curso, completado, invalidado, cancelado) y fechas. Ideal para medir su resultado."}},"/folders":{"get":{"operationId":"folder.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar carpetas","tags":["Folder"],"parameters":[{"name":"name","in":"query","schema":{"type":["string","null"],"maxLength":255}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FolderResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar las carpetas donde se organizan los flujos, con su jerarquía y cantidad de flujos, por ejemplo para filtrar flujos por carpeta."},"post":{"operationId":"folder.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear una carpeta","tags":["Folder"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFolderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para crear una carpeta (o una subcarpeta, con `parent_id`) y organizar tus flujos."}},"/folders/{folder}":{"get":{"operationId":"folder.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver una carpeta","tags":["Folder"],"parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FolderResource"},{"type":"object","required":["children"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver una carpeta de flujos con sus subcarpetas y cuántos flujos contiene."},"put":{"operationId":"folder.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar una carpeta","tags":["Folder"],"parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFolderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para renombrar una carpeta de flujos o moverla dentro de otra cambiando `parent_id`."},"delete":{"operationId":"folder.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar una carpeta","tags":["Folder"],"parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para eliminar una carpeta de flujos que ya no necesitás."}},"/contacts/{contact}/messages/{message}/forward":{"post":{"operationId":"forwardMessage.store","description":"**Permiso requerido:** `conversations:send`","summary":"Reenviar un mensaje","tags":["ForwardMessage"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"message","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardMessageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"contact_id":{"type":"integer"},"mode":{"type":"string","enum":["internal","native"]},"status":{"type":"string","enum":["queued","blocked"]},"reason":{"type":["string","null"]},"message":{"anyOf":[{"$ref":"#/components/schemas/PublicMessageResource"},{"type":"null"}]}},"required":["contact_id","mode","status","reason","message"]}}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["window_closed","antiblock_duplicate_content","antiblock_unanswered_limit","recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["device_unavailable"]},"message":{"type":"string"}},"required":["error","message"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","enum":["Server Error"]}},"required":["message"]}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Usalo para reenviar un mensaje de una conversación a otros contactos, eligiendo desde qué número sale cada envío; la respuesta indica el resultado por destino."}},"/kanban-settings":{"get":{"operationId":"kanbanSetting.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar tableros","tags":["KanbanSetting"],"parameters":[{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/KanbanSettingResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar tus tableros kanban y obtener sus IDs, necesarios para mover contactos de etapa o filtrar conversaciones y difusiones por tablero."},"post":{"operationId":"kanbanSetting.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear un tablero","tags":["KanbanSetting"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreKanbanSettingRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KanbanSettingResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para crear un tablero kanban, basado en etapas o en etiquetas, por ejemplo para modelar tu embudo de ventas o de atención dentro de Funnelchat."}},"/kanban-settings/{kanbanSetting}":{"get":{"operationId":"kanbanSetting.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver un tablero","tags":["KanbanSetting"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/KanbanSettingResource"},{"type":"object","required":["stages"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver la configuración de un tablero: modo, etapas, días para considerar estancado a un contacto y los campos de valor y ganancia asociados."},"put":{"operationId":"kanbanSetting.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar un tablero","tags":["KanbanSetting"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKanbanSettingRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KanbanSettingResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para ajustar un tablero existente: nombre, estructura, días de estancamiento, vista, ícono o si se colorea por lead score."},"delete":{"operationId":"kanbanSetting.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar un tablero","tags":["KanbanSetting"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para eliminar un tablero kanban que ya no usás."}},"/kanban-settings/{kanbanSetting}/members":{"get":{"operationId":"kanbanSetting.members","description":"**Permiso requerido:** `conversations:read`","summary":"Ver los miembros de un tablero","tags":["KanbanSetting"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}},{"name":"contact_ids[]","in":"query","schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"member_contact_ids":{"type":"array","items":{"type":"integer"}}},"required":["member_contact_ids"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para chequear en una sola llamada cuáles de un conjunto de contactos están en un tablero, por ejemplo antes de moverlos o agregarlos."}},"/contacts/{contact}/kanban-stages":{"get":{"operationId":"kanbanStage.contactStages","description":"**Permiso requerido:** `conversations:read`","summary":"Ver las etapas de un contacto en los tableros","tags":["KanbanStage"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactKanbanStageBoardResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para saber en qué etapa está un contacto en cada tablero, útil para reflejar su avance en el embudo dentro de tu CRM."}},"/kanban-settings/{kanbanSetting}/move-contact":{"post":{"operationId":"kanbanStage.moveContact","description":"**Permiso requerido:** `conversations:write`","summary":"Mover un contacto de etapa","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveContactStageRequest"}}}},"responses":{"200":{"description":"OK"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para mover un contacto a otra etapa del tablero cuando algo pasa en tu sistema, por ejemplo al recibir un pago o agendar una demo."}},"/kanban-settings/{kanbanSetting}/bulk-move":{"post":{"operationId":"kanbanStage.bulkMove","description":"**Permiso requerido:** `conversations:write`","summary":"Mover contactos de etapa en bloque","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkMoveStageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":["object","null"],"properties":{"excluded_inactive":{"type":"integer","description":"Cantidad de contactos inactivos que no se movieron. El cuerpo es `null` cuando no se dejó afuera a ninguno.","minimum":1}},"required":["excluded_inactive"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para mover muchos contactos a una misma etapa de una sola vez, por ejemplo al cerrar una campaña o importar resultados."}},"/kanban-settings/{kanbanSetting}/remove-contact":{"post":{"operationId":"kanbanStage.removeContact","description":"**Permiso requerido:** `conversations:write`","summary":"Sacar un contacto del tablero","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveContactStageRequest"}}}},"responses":{"200":{"description":"OK"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para sacar a un contacto de un tablero cuando deja de estar en ese proceso, por ejemplo si se perdió o se descartó."}},"/kanban-settings/{kanbanSetting}/bulk-remove":{"post":{"operationId":"kanbanStage.bulkRemove","description":"**Permiso requerido:** `conversations:write`","summary":"Sacar contactos del tablero en bloque","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRemoveStageRequest"}}}},"responses":{"200":{"description":"OK"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para sacar varios contactos de un tablero en una sola llamada."}},"/kanban-settings/{kanbanSetting}/stages":{"post":{"operationId":"kanbanStage.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear una etapa","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreKanbanStageRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KanbanStageResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para agregar una etapa nueva a un tablero, ubicándola después de una etapa existente."}},"/kanban-settings/{kanbanSetting}/stages/reorder":{"post":{"operationId":"kanbanStage.reorder","description":"**Permiso requerido:** `conversations:write`","summary":"Reordenar las etapas","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderKanbanStagesRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KanbanStageResource"}}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para cambiar el orden de las etapas de un tablero enviando la lista de IDs en el orden que querés."}},"/kanban-settings/{kanbanSetting}/stages/{stage}":{"put":{"operationId":"kanbanStage.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar una etapa","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}},{"name":"stage","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKanbanStageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KanbanStageResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para renombrar una etapa de un tablero."},"delete":{"operationId":"kanbanStage.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar una etapa","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}},{"name":"stage","in":"path","required":true,"schema":{"type":"integer"}},{"name":"reassign_to_stage_id","in":"query","schema":{"type":["integer","null"]}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para eliminar una etapa de un tablero; con `reassign_to_stage_id` podés pasar sus contactos a otra etapa."}},"/kanban-settings/{kanbanSetting}/stages/{stage}/contacts":{"get":{"operationId":"kanbanStage.contacts","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los contactos de una etapa","tags":["KanbanStage"],"parameters":[{"name":"kanbanSetting","in":"path","required":true,"schema":{"type":"integer"}},{"name":"stage","in":"path","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"search","in":"query","schema":{"type":"string"}},{"name":"messages","in":"query","schema":{"type":"string","enum":["all","read","unread"]}},{"name":"dateFrom","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"dateBasis","in":"query","schema":{"type":"string","enum":["board_entry","created","last_activity"]}},{"name":"adviserId","in":"query","schema":{"type":"string"}},{"name":"valueMin","in":"query","schema":{"type":"number"}},{"name":"valueMax","in":"query","schema":{"type":"number"}},{"name":"stagnant","in":"query","schema":{"type":"boolean"}},{"name":"tagIds[]","in":"query","schema":{"type":"array","items":{"type":"integer"}}},{"name":"leadScoreCategories[]","in":"query","schema":{"type":"array","enum":["insufficient_data","hot","warm","cold"],"items":{"type":"string","enum":["insufficient_data","hot","warm","cold"]}}},{"name":"leadScoreMin","in":"query","schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"leadScoreMax","in":"query","schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"leadScoreDisqualified","in":"query","schema":{"type":["string","null"],"enum":["include","exclude","only",null]}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","last_message_time","stage_since"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para traer los contactos de una etapa con filtros (asesor, valor, estancados, etiquetas, lead score, fechas), por ejemplo para armar seguimientos o reportes del embudo."}},"/lead-score/distribution":{"get":{"operationId":"leadScoreDistribution.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver la distribución del lead score","tags":["LeadScoreDistribution"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadScoreDistributionResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver cómo se reparte tu base entre leads calientes, tibios, fríos y sin datos suficientes, junto con los umbrales vigentes. Ideal para un tablero de calidad de leads."}},"/lead-score/events":{"post":{"operationId":"leadScoreEventIngest.ingest","description":"**Permiso requerido:** `conversations:write`","summary":"Registrar un evento de lead score","tags":["LeadScoreEventIngest"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestLeadScoreEventsRequest"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para alimentar el lead score con señales de interacción (entradas y salidas de grupos, reacciones, votos en encuestas, clics en links) por contacto o teléfono. Se acepta para procesar después (`202`)."}},"/lead-score/settings":{"get":{"operationId":"leadScoreSettings.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver la configuración del lead score","tags":["LeadScoreSettings"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadScoreSettingsResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para leer cómo se calcula el lead score de tu cuenta: umbrales de caliente y tibio, señales mínimas, histéresis, decaimiento y reglas."},"put":{"operationId":"leadScoreSettings.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar la configuración del lead score","tags":["LeadScoreSettings"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadScoreSettingsResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para ajustar el cálculo del lead score a tu negocio: umbrales de categoría, señales mínimas, histéresis, decaimiento con el paso de los días y reglas."}},"/contacts/{contact}/lead-score/adjustments":{"post":{"operationId":"leadScoreSettings.adjust","description":"**Permiso requerido:** `conversations:write`","summary":"Ajustar el lead score de un contacto","tags":["LeadScoreSettings"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreLeadScoreAdjustmentRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"score":{"type":"integer"},"signals_count":{"type":"integer"},"category":{"type":"string"},"confidence":{"type":"string"},"disqualified":{"type":"boolean"},"disqualified_at":{"type":["string","null"]}},"required":["score","signals_count","category","confidence","disqualified","disqualified_at"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para sumar o restar puntos al lead score de un contacto a mano, con un motivo, por ejemplo cuando tu equipo comercial confirma interés por otro canal."}},"/mac/status":{"get":{"operationId":"mac.status","description":"**Permiso requerido:** `conversations:read`","summary":"Ver el consumo de MACs","tags":["Mac"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"enforcement_enabled":{"type":"boolean"},"state":{"type":"string","description":"Estado del límite de contactos activos de tu cuenta: `normal`; `grace`, alcanzaste el límite y corren las 24 horas de gracia; `enforcing`, bloqueo: hay contactos inactivos; `cleared`, el último período de gracia o de bloqueo ya terminó.","enum":["normal","grace","enforcing","cleared"]},"inactive_contacts_count":{"type":"integer","description":"Contactos registrados como inactivos en el ciclo actual: a los que se les frenó un mensaje, que te escribieron estando inactivos o que una difusión dejó afuera. No es el total de contactos que podrían serlo: para un contacto puntual, usa `is_mac_inactive`.","minimum":0}},"required":["enforcement_enabled","state","inactive_contacts_count"]},{"type":"object","properties":{"enforcement_enabled":{"type":"boolean"},"current_count":{"type":"integer","const":0},"limit":{"type":"integer","const":0},"remaining":{"type":"integer","const":0},"usage_percentage":{"type":"integer","const":0},"state":{"type":"string","const":"normal"},"grace":{"type":"null"},"period_start":{"type":"null"}},"required":["enforcement_enabled","current_count","limit","remaining","usage_percentage","state","grace","period_start"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para saber en qué estado está el límite de contactos activos de tu cuenta (normal, en las 24 horas de gracia o en bloqueo) y cuántos contactos quedaron inactivos en el ciclo, y anticiparte antes de que se frenen envíos."}},"/mac/contacts":{"get":{"operationId":"mac.contacts","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los contactos que cuentan como MAC","tags":["Mac"],"parameters":[{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver qué contactos están contando como MAC, útil para entender qué está consumiendo tu cupo."}},"/mac/contacts/history":{"get":{"operationId":"mac.contactsHistory","description":"**Permiso requerido:** `conversations:read`","summary":"Ver el historial de MACs","tags":["Mac"],"parameters":[{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para consultar el historial de MACs y analizar cómo evolucionó el consumo a lo largo del tiempo."}},"/message/send-message":{"post":{"operationId":"message.sendMessage","description":"**Permiso requerido:** `conversations:send`","summary":"Enviar un mensaje","tags":["Message"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendDirectMessageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"anyOf":[{"$ref":"#/components/schemas/PublicMessageResource"},{"type":"null"}]}},"required":["message"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error":{"type":"string"}},"required":["status","error"]}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["window_closed","antiblock_duplicate_content","antiblock_unanswered_limit","recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["device_unavailable","not_sent"]},"message":{"type":"string"}},"required":["error","message"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","enum":["Server Error"]}},"required":["message"]}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Sirve para enviar un mensaje de texto o un archivo a un contacto, indicando en el cuerpo el `contact_id` y el número desde el que sale."}},"/contacts/{contact}/messages/{message}/reaction":{"put":{"operationId":"messageReaction.update","description":"**Permiso requerido:** `conversations:send`","summary":"Reaccionar a un mensaje","tags":["MessageReaction"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"message","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreMessageReactionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Usalo para reaccionar con un emoji a un mensaje de una conversación, por ejemplo para acusar recibo sin escribir una respuesta."},"delete":{"operationId":"messageReaction.destroy","description":"**Permiso requerido:** `conversations:send`","summary":"Quitar una reacción","tags":["MessageReaction"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"message","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object"}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Sirve para quitar la reacción que pusiste en un mensaje."}},"/templates":{"get":{"operationId":"messageTemplate.templates","description":"**Permiso requerido:** `conversations:read`","summary":"Listar plantillas","tags":["MessageTemplate"],"parameters":[{"name":"name","in":"query","schema":{"type":["string","null"]}},{"name":"uid","in":"query","schema":{"type":["string","null"]}},{"name":"language_code","in":"query","schema":{"type":["string","null"]}},{"name":"status","in":"query","schema":{"type":["string","null"],"enum":["PENDING","APPROVED","REJECTED","PENDING_DELETION","PAUSED","DISABLED","ARCHIVED",null]}},{"name":"category","in":"query","schema":{"type":["string","null"]}},{"name":"deviceId","in":"query","schema":{"type":["integer","null"]}},{"name":"type","in":"query","schema":{"type":["string","null"],"enum":["text","image","document","video","location","default",null]}},{"name":"created_by_webhook","in":"query","schema":{"type":"boolean"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","created_at","updated_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para listar tus plantillas de WhatsApp con su estado de aprobación, categoría, idioma y número, y elegir cuál usar en un envío o una difusión."},"post":{"operationId":"messageTemplate.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear una plantilla","tags":["MessageTemplate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreMessageTemplateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para crear una plantilla de WhatsApp (encabezado, cuerpo con variables, pie y botones) desde tu sistema, sin pasar por el panel."}},"/templates/{template}":{"put":{"operationId":"messageTemplate.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar una plantilla","tags":["MessageTemplate"],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageTemplateRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","const":"Approved templates can be edited up to 10 times in a 30-day period or once in a 24-hour period."}},"required":["error"]},{"type":"object","properties":{"error":{"type":"string","const":"Templates with pending status cannot be updated."}},"required":["error"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para editar el contenido de una plantilla existente: categoría, encabezado, cuerpo, variables, pie o botones."},"get":{"operationId":"messageTemplate.template","description":"**Permiso requerido:** `conversations:read`","summary":"Ver una plantilla","tags":["MessageTemplate"],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver una plantilla completa, con su estado, variables y botones, por ejemplo para saber qué valores completar al enviarla."}},"/templates/{template}/quick-reply-buttons":{"get":{"operationId":"messageTemplate.quickReplyButtons","description":"**Permiso requerido:** `conversations:read`","summary":"Ver los botones de respuesta rápida de una plantilla","tags":["MessageTemplate"],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para obtener los botones de respuesta rápida de una plantilla, por ejemplo para preparar qué hacer según el botón que toque el contacto."}},"/devices/{device}/templates/{template}/send-template":{"post":{"operationId":"messageTemplate.send","description":"**Permiso requerido:** `conversations:send`","summary":"Enviar una plantilla","tags":["MessageTemplate"],"parameters":[{"name":"device","in":"path","required":true,"schema":{"type":"integer"}},{"name":"template","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"contact_id":{"type":"integer"},"template_variables":{"type":"object","properties":{"body":{"type":"array","items":{"type":["string","null"],"maxLength":1024},"maxItems":100}}},"client_reference":{"type":["string","null"],"pattern":"^[\\x21-\\x7E]{1,64}$","maxLength":64}},"required":["phone","contact_id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"anyOf":[{"$ref":"#/components/schemas/PublicMessageResource"},{"type":"null"}]}},"required":["message"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["template_not_found"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["Contact not found"]}},"required":["error"]},{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}]}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["antiblock_duplicate_content","antiblock_unanswered_limit","recipient_mismatch","recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["device_unavailable","not_sent"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["template_unresolved_placeholder"]},"message":{"type":"string"},"placeholders":{"type":"array","items":{"type":"string"}},"count":{"type":"integer"}},"required":["error","message","placeholders","count"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","enum":["Server Error"]}},"required":["message"]}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Sirve para enviar una plantilla desde uno de tus números a un teléfono o contacto, completando sus variables, por ejemplo un aviso, un recordatorio o una confirmación."}},"/devices/{device}/templates/{template}":{"delete":{"operationId":"messageTemplate.delete","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar una plantilla de un número","tags":["MessageTemplate"],"parameters":[{"name":"device","in":"path","required":true,"schema":{"type":"integer"}},{"name":"template","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para eliminar una plantilla de uno de tus números cuando ya no la vas a usar."}},"/payments/products/{platform}":{"get":{"operationId":"paymentProduct.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los productos de una plataforma de pagos","tags":["PaymentProduct"],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentProductResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar los productos de una plataforma de pagos con su ID externo y nombre, por ejemplo para relacionarlos con las ventas que reporta Funnelchat."}},"/quick-replies":{"get":{"operationId":"quickReply.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar respuestas rápidas","tags":["QuickReply"],"parameters":[{"name":"search","in":"query","schema":{"type":"string"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["created_at","updated_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QuickReplyResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para listar las respuestas rápidas de la cuenta, por ejemplo para ofrecerlas en tu propia interfaz de atención."},"post":{"operationId":"quickReply.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear una respuesta rápida","tags":["QuickReply"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":30},"message":{"type":["string","null"],"maxLength":2500},"file":{"type":["string","null"]},"type":{"$ref":"#/components/schemas/MessageTypeEnum"},"visibility":{"$ref":"#/components/schemas/QuickReplyVisibilityEnum"},"agent_ids":{"type":["array","null"],"items":{"type":"integer"}}},"required":["name","type","visibility"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickReplyResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para crear una respuesta rápida con texto o archivo y definir quién la ve (visibilidad y agentes), así el equipo responde más rápido lo frecuente."}},"/quick-replies/{quickReply}":{"get":{"operationId":"quickReply.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver una respuesta rápida","tags":["QuickReply"],"parameters":[{"name":"quickReply","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickReplyResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para ver una respuesta rápida con su contenido, su tipo y los agentes que la tienen disponible."},"put":{"operationId":"quickReply.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar una respuesta rápida","tags":["QuickReply"],"parameters":[{"name":"quickReply","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":30},"message":{"type":["string","null"],"maxLength":2500},"file":{"type":["string","null"]},"type":{"$ref":"#/components/schemas/MessageTypeEnum"},"visibility":{"$ref":"#/components/schemas/QuickReplyVisibilityEnum"},"agent_ids":{"type":["array","null"],"items":{"type":"integer"}}},"required":["name","type","visibility"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickReplyResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para actualizar el contenido o la visibilidad de una respuesta rápida."},"delete":{"operationId":"quickReply.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar una respuesta rápida","tags":["QuickReply"],"parameters":[{"name":"quickReply","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para eliminar una respuesta rápida que ya no se usa."}},"/sales/metrics":{"get":{"operationId":"salesDashboard.metrics","description":"**Permiso requerido:** `conversations:read`","summary":"Ver las métricas de ventas","tags":["SalesDashboard"],"parameters":[{"name":"window","in":"query","schema":{"type":"integer","enum":["7","30","90"]}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"event_type[]","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentEventTypeEnum"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesMetricsResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para obtener métricas de ventas de los últimos 7, 30 o 90 días: totales por moneda, compradores distintos y tasa de recompra. Ideal para un tablero comercial."}},"/sales/funnel":{"get":{"operationId":"salesDashboard.funnel","description":"**Permiso requerido:** `conversations:read`","summary":"Ver el embudo de ventas","tags":["SalesDashboard"],"parameters":[{"name":"window","in":"query","schema":{"type":"integer","enum":["7","30","90"]}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"event_type[]","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentEventTypeEnum"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"conversations":{"type":"integer","minimum":0},"qualified":{"type":["integer","null"],"minimum":0},"purchases":{"type":"object","properties":{"buyers":{"type":"integer","minimum":0},"amounts":{"type":"array","items":{}}},"required":["buyers","amounts"]}},"required":["conversations","qualified","purchases"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para ver el embudo de conversaciones a leads calificados y a compras en una ventana de 7, 30 o 90 días, y medir cuánto convierte tu atención por WhatsApp."}},"/sales/by-platform":{"get":{"operationId":"salesDashboard.byPlatform","description":"**Permiso requerido:** `conversations:read`","summary":"Ver las ventas por plataforma","tags":["SalesDashboard"],"parameters":[{"name":"window","in":"query","schema":{"type":"integer","enum":["7","30","90"]}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"event_type[]","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentEventTypeEnum"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"platforms":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"connected":{"type":"boolean"},"totals":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"total_minor":{"type":"integer"}},"required":["currency","total_minor"]}}},"required":["platform","connected","totals"]}}},"required":["platforms"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para comparar las ventas por plataforma de pagos en la ventana elegida y ver cuáles están conectadas."}},"/sales":{"get":{"operationId":"salesDashboard.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar ventas","tags":["SalesDashboard"],"parameters":[{"name":"window","in":"query","schema":{"type":"integer","enum":["7","30","90"]}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1}},{"name":"event_type[]","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentEventTypeEnum"}}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SaleResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para traer el detalle de ventas (producto, monto, plataforma, estado, comprador y atribución) de los últimos 7, 30 o 90 días, por ejemplo para conciliar con tu sistema."}},"/contacts/{contact}/messages/{message}":{"get":{"operationId":"message.showMessage","description":"$128","summary":"Ver un mensaje","tags":["ShowMessage"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}},{"name":"message","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicMessageResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para saber qué pasó con un mensaje que enviaste: con el id que te devolvió el envío ves su estado (en cola, enviado, entregado, leído o fallido) y, si falló, el motivo."}},"/tags":{"get":{"operationId":"tag.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar etiquetas","tags":["Tag"],"parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"withContactCount","in":"query","schema":{"type":"boolean"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","created_at","updated_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar las etiquetas de la cuenta, opcionalmente con cuántos contactos tiene cada una, y obtener sus IDs para filtrar o segmentar."},"post":{"operationId":"tag.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear una etiqueta","tags":["Tag"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":254},"description":{"type":["string","null"],"maxLength":1024},"color":{"type":["string","null"],"maxLength":191}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para crear una etiqueta (nombre, descripción, color) y segmentar contactos según los criterios de tu negocio."}},"/tags/{tag}":{"get":{"operationId":"tag.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver una etiqueta","tags":["Tag"],"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"integer"}},{"name":"withContactCount","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResource"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver una etiqueta y, si lo pedís, cuántos contactos la tienen."},"put":{"operationId":"tag.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar una etiqueta","tags":["Tag"],"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":["string","null"],"maxLength":1024},"color":{"type":["string","null"],"maxLength":191}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["Ya existe un tag con este nombre."]}},"required":["message"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para renombrar una etiqueta o cambiar su descripción o su color."}},"/tags/{tag}/contacts":{"get":{"operationId":"tag.contacts","description":"**Permiso requerido:** `conversations:read`","summary":"Listar los contactos con una etiqueta","tags":["Tag"],"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","last_message_time"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"sortBy","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para obtener todos los contactos que tienen una etiqueta, por ejemplo para exportar un segmento o sincronizarlo con otra herramienta."}},"/tags/delete":{"post":{"operationId":"tag.destroy","description":"**Permiso requerido:** `conversations:write`","summary":"Eliminar etiquetas","tags":["Tag"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tagIds":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["tagIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para eliminar varias etiquetas de una vez."}},"/tickets":{"get":{"operationId":"ticket.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar tickets","tags":["Ticket"],"parameters":[{"name":"status","in":"query","schema":{"type":"integer","enum":["0","1","2"]}},{"name":"userId","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar los tickets de la cuenta filtrando por estado o por usuario asignado, por ejemplo para armar una vista de casos pendientes."},"post":{"operationId":"ticket.store","description":"**Permiso requerido:** `conversations:write`","summary":"Crear un ticket","tags":["Ticket"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer"},"contactId":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"}},"required":["userId","contactId","title","description"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Contacto no encontrado."}},"required":["message"]}}}},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para abrir un ticket sobre un contacto (título y descripción) y asignárselo a un usuario del equipo, por ejemplo cuando tu sistema detecta un reclamo."}},"/tickets/{id}":{"get":{"operationId":"ticket.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver un ticket","tags":["Ticket"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para ver un ticket con su contacto, su responsable, la descripción y la fecha límite."},"put":{"operationId":"ticket.update","description":"**Permiso requerido:** `conversations:write`","summary":"Actualizar un ticket","tags":["Ticket"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}},"required":["title","description"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para corregir o ampliar el título y la descripción de un ticket."}},"/tickets/assign":{"post":{"operationId":"ticket.assignTicketToUser","description":"**Permiso requerido:** `conversations:write`","summary":"Asignar tickets","tags":["Ticket"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer"},"userId":{"type":"integer"}},"required":["ticketId","userId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","const":"Ticket successfully assigned"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para reasignar un ticket a otro usuario del equipo."}},"/tickets/{id}/close":{"post":{"operationId":"ticket.closeTicket","description":"**Permiso requerido:** `conversations:write`","summary":"Cerrar un ticket","tags":["Ticket"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para cerrar un ticket cuando el caso quedó resuelto."}},"/tickets/{id}/reopen":{"post":{"operationId":"ticket.reOpenTicket","description":"**Permiso requerido:** `conversations:write`","summary":"Reabrir un ticket","tags":["Ticket"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","const":"Ticket re-opened"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para reabrir un ticket cerrado si el caso vuelve a necesitar atención."}},"/agents/{user}":{"get":{"operationId":"user.show","description":"**Permiso requerido:** `conversations:read`","summary":"Ver un agente","tags":["User"],"parameters":[{"name":"user","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UserResource"},{"type":"object"}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para ver los datos de un agente (nombre, email y alcance como asesor), por ejemplo para mostrar quién atiende una conversación."}},"/agents":{"get":{"operationId":"user.index","description":"**Permiso requerido:** `conversations:read`","summary":"Listar agentes","tags":["User"],"parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"email","in":"query","schema":{"type":"string","format":"email"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["name","email","created_at"]}},{"name":"orderByMethod","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para listar los agentes de la cuenta y obtener sus IDs, que necesitás para asignar conversaciones o tickets y filtrar por asesor."}},"/webhooks/{webhook}/deliveries":{"get":{"operationId":"webhookDelivery.index","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve, de la más reciente a la más antigua, los intentos de entrega de una suscripción: estado, código HTTP recibido, duración y fecha del próximo reintento. Admite paginación con `perPage` (entero de 1 a 100; 25 si no se manda).","summary":"Listar entregas de un webhook","tags":["WebhookDelivery"],"parameters":[{"name":"webhook","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"maximum":10000}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDeliveryResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para depurar tu webhook: ves cada intento de entrega con su estado, código HTTP, duración y cuándo será el próximo reintento."}},"/webhooks/events":{"get":{"operationId":"webhookEventCatalog.index","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve el catálogo de tipos de evento a los que se puede suscribir un webhook, con su estado, si es suscribible y un ejemplo del cuerpo que se envía.","summary":"Listar tipos de evento","tags":["WebhookEventCatalog"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Sirve para conocer los tipos de evento de conversaciones a los que te podés suscribir, con su estado y un ejemplo del cuerpo que vas a recibir."}},"/webhooks":{"get":{"operationId":"webhookSubscription.index","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve las suscripciones de webhook de la cuenta, de la más nueva a la más antigua. Admite paginación con `perPage` (entero de 1 a 100; 25 si no se manda).","summary":"Listar webhooks","tags":["WebhookSubscription"],"parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"maximum":10000}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscriptionResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para revisar qué suscripciones de webhook tiene la cuenta y a qué eventos escucha cada una."},"post":{"operationId":"webhookSubscription.store","description":"**Permiso requerido:** `conversations:write`\n\nCrea una suscripción a uno o más tipos de evento. El secreto de firma se devuelve en esta respuesta una sola vez: guardalo, no se puede volver a consultar.","summary":"Crear un webhook","tags":["WebhookSubscription"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreWebhookSubscriptionRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/WebhookSubscriptionResource"},{"type":"object","properties":{"secret":{"type":"string","description":"Secreto de firma, en claro. Solo viene al crear la suscripción y al rotar el secreto: no se puede volver a consultar."}},"required":["secret"]}]}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para recibir eventos en tu sistema (mensajes recibidos, cambios de etapa, etiquetas, difusiones terminadas) sin consultar la API cada tanto. Guardá el secreto de firma: se muestra una sola vez."}},"/webhooks/{webhook}":{"get":{"operationId":"webhookSubscription.show","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve una suscripción de la cuenta por su identificador.","summary":"Ver un webhook","tags":["WebhookSubscription"],"parameters":[{"name":"webhook","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookSubscriptionResource"}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:read","x-fc-proposito":"Usalo para ver la configuración actual de una suscripción de webhook: URL, eventos y estado."},"put":{"operationId":"webhookSubscription.update","description":"**Permiso requerido:** `conversations:write`\n\nModifica la URL, los tipos de evento o el estado activo de una suscripción.","summary":"Actualizar un webhook","tags":["WebhookSubscription"],"parameters":[{"name":"webhook","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookSubscriptionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookSubscriptionResource"}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para cambiar la URL, los eventos o el estado activo de un webhook, por ejemplo al migrar de servidor o pausar la recepción."},"delete":{"operationId":"webhookSubscription.destroy","description":"**Permiso requerido:** `conversations:write`\n\nElimina una suscripción. Deja de recibir eventos de inmediato.","summary":"Eliminar un webhook","tags":["WebhookSubscription"],"parameters":[{"name":"webhook","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para dar de baja un webhook; deja de recibir eventos de inmediato."}},"/webhooks/{webhook}/rotate-secret":{"post":{"operationId":"webhookSubscription.rotateSecret","description":"**Permiso requerido:** `conversations:write`\n\nGenera un secreto de firma nuevo y lo devuelve una sola vez. El anterior deja de ser válido.","summary":"Rotar el secreto de un webhook","tags":["WebhookSubscription"],"parameters":[{"name":"webhook","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/WebhookSubscriptionResource"},{"type":"object","properties":{"secret":{"type":"string","description":"Secreto de firma, en claro. Solo viene al crear la suscripción y al rotar el secreto: no se puede volver a consultar."}},"required":["secret"]}]}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Sirve para renovar el secreto de firma de un webhook si se filtró o por política de seguridad. El anterior deja de valer y el nuevo se muestra una sola vez."}},"/webhooks/{webhook}/test":{"post":{"operationId":"webhook.webhookTest","description":"**Permiso requerido:** `conversations:write`\n\nEnvía ahora un evento `webhook.test` firmado a la URL de la suscripción y devuelve el intento como un ítem del historial de entregas; queda en el historial y no se reintenta.","summary":"Enviar un evento de prueba","tags":["WebhookTest"],"parameters":[{"name":"webhook","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookDeliveryResource"}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"$ref":"#/components/responses/ModelNotFoundException"}},"x-fc-permission":"conversations:write","x-fc-proposito":"Usalo para probar tu endpoint antes de depender de él: envía ya un evento `webhook.test` firmado y te devuelve el resultado de la entrega."}},"/forms/templates":{"get":{"operationId":"whatsappForm.templates","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve las plantillas con las que puedes empezar un formulario nuevo: `key`, `title`, `description` y `category`. El catálogo es fijo y el mismo para todas las cuentas.","summary":"GET /forms/templates","tags":["WhatsappForm"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappFormTemplate"}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read"}},"/forms":{"get":{"operationId":"whatsappForm.index","description":"**Permiso requerido:** `conversations:read`\n\nLista los formularios de tu cuenta, uno por formulario aunque tenga varias versiones; de cada uno ves la versión que usas hoy (la publicada o, si no hay, la más nueva). El `id` de cada fila es el de esa versión y `family_id` es el del formulario. Filtra con `q` (parte del nombre), `status` (`draft`, `published` o `deprecated`) y `device_id` (un número de tu cuenta; si no es WhatsApp Cloud responde 422 `NUMBER_NOT_ELIGIBLE`). Pagina con `perPage` (1 a 100, 25 por defecto).","summary":"GET /forms","tags":["WhatsappForm"],"parameters":[{"name":"q","in":"query","schema":{"type":["string","null"],"maxLength":191}},{"name":"status","in":"query","schema":{"type":["string","null"],"enum":["draft","published","deprecated",null]}},{"name":"device_id","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"page","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappFormResource"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read"},"post":{"operationId":"whatsappForm.store","description":"**Permiso requerido:** `conversations:write`\n\nCrea un formulario nuevo como borrador de tu cuenta. Envía `template_key` (una de las `key` de `GET /forms/templates`; `blank` empieza vacío), `device_id` (un número de WhatsApp Cloud de tu cuenta) y, si quieres, `device_ids` con otros números donde también vivirá. Responde 201 con la versión (`id`), su `family_id`, `lint` y `numbers`. Si un número no es de tu cuenta o no es WhatsApp Cloud responde 422 `NUMBER_NOT_ELIGIBLE`.","summary":"POST /forms","tags":["WhatsappForm"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreWhatsappFormRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WhatsappFormResource"},"lint":{"type":"array","items":{}},"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["data","lint","numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write"}},"/forms/families/{familyId}/metrics":{"get":{"operationId":"whatsappForm.metrics","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve los números de un formulario de tu cuenta: cuántos se enviaron, cuántos se abrieron y cuántos se completaron, y sus porcentajes. `{familyId}` es el `family_id` del formulario. Acepta los mismos filtros de fecha, versión y origen que la lista de respuestas; un filtro inválido responde 422. Responde 404 si el formulario no existe o no es de tu cuenta.","summary":"GET /forms/families/{familyId}/metrics","tags":["WhatsappForm"],"parameters":[{"name":"familyId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"from","in":"query","schema":{"type":["string","null"],"format":"date-time"}},{"name":"to","in":"query","schema":{"type":["string","null"],"format":"date-time"}},{"name":"version_id","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"origin","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"status","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"kind","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"effect_status","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"search","in":"query","schema":{"type":["string","null"],"maxLength":191}},{"name":"per_page","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"page","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"not_sent":{"type":"integer"},"not_sent_reasons":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"reason":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer"}},"required":["reason","label","count"]},{"type":"object","properties":{"reason":{"type":"string","const":"desconocido"},"label":{"type":"string","const":"sin motivo registrado"},"count":{"type":"integer"}},"required":["reason","label","count"]}]}},"sent":{"type":"integer"},"delivered":{"type":"integer"},"read":{"type":"integer"},"completed":{"type":"integer"},"pending":{"type":"integer"},"unfinished":{"type":"integer"},"partial":{"type":"integer"},"completion_rate":{"type":["number","null"]},"delivery_rate":{"type":["number","null"]},"read_rate":{"type":["number","null"]},"median_seconds_to_complete":{"type":["integer","null"]}},"required":["not_sent","not_sent_reasons","sent","delivered","read","completed","pending","unfinished","partial","completion_rate","delivery_rate","read_rate","median_seconds_to_complete"]}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read"}},"/forms/families/{familyId}/responses":{"get":{"operationId":"whatsappForm.responses","description":"**Permiso requerido:** `conversations:read`\n\nLista las respuestas de un formulario de tu cuenta, de la más reciente a la más antigua, sumando todas sus versiones. Junto a `data` viene `columns`, las preguntas que usan esas respuestas. `{familyId}` es el `family_id` del formulario. Filtra con `from` y `to` (fechas), `version_id` (el `id` de una versión de ese formulario), `origin`, `status` y `search` (nombre o teléfono del contacto). Un filtro con un valor inválido responde 422. Pagina con `perPage` (1 a 100, 25 por defecto). Responde 404 si el formulario no existe o no es de tu cuenta.","summary":"GET /forms/families/{familyId}/responses","tags":["WhatsappForm"],"parameters":[{"name":"familyId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"from","in":"query","schema":{"type":["string","null"],"format":"date-time"}},{"name":"to","in":"query","schema":{"type":["string","null"],"format":"date-time"}},{"name":"version_id","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"origin","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"status","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"kind","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"effect_status","in":"query","schema":{"type":["string","null"],"maxLength":24}},{"name":"search","in":"query","schema":{"type":["string","null"],"maxLength":191}},{"name":"page","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:read"}},"/forms/families/{familyId}/responses/{runId}":{"get":{"operationId":"whatsappForm.response","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve una respuesta completa de un formulario de tu cuenta: las respuestas del contacto y lo que se hizo con ellas. `{familyId}` es el `family_id` del formulario y `{runId}` el `id` de la respuesta que viene en `GET /forms/families/{familyId}/responses`. Responde 404 si no existe o no es de tu cuenta.","summary":"GET /forms/families/{familyId}/responses/{runId}","tags":["WhatsappForm"],"parameters":[{"name":"familyId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"runId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"flow_token":{"type":"string"},"contact":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":["string","null"]},"phone":{"type":["string","null"]}},"required":["id","name","phone"]},"status":{"anyOf":[{"type":"object","properties":{"key":{"type":"string","const":"completed"},"label":{"type":"string","const":"Completado"}},"required":["key","label"]},{"type":"object","properties":{"key":{"type":"string","const":"pending"},"label":{"type":"string","const":"Esperando respuesta"}},"required":["key","label"]},{"type":"object","properties":{"key":{"type":"string","const":"unfinished"},"label":{"type":"string","const":"Sin completar"}},"required":["key","label"]},{"type":"object","properties":{"key":{"type":"string","const":"not_sent"},"label":{"type":"string","const":"No enviado"}},"required":["key","label"]}]},"origin":{"type":"string"},"node_id":{"type":["string","null"]},"automation_run_id":{"type":["integer","null"]},"conversation_id":{"type":["integer","null"]},"version":{"type":"integer"},"version_id":{"type":"integer"},"output_id":{"type":["string","null"]},"output_label":{"type":["string","null"]},"reason":{"type":["string","null"]},"reason_label":{"type":["string","null"]},"completed_after_expiry":{"type":"boolean"},"partial":{"type":"string"},"last_screen_id":{"type":["string","null"]},"sent_at":{"type":["string","null"]},"delivered_at":{"type":["string","null"]},"read_at":{"type":["string","null"]},"responded_at":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"answers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"unknown":{"type":"boolean"}},"required":["name","label","value","unknown"]}},"effects":{"type":"array","items":{"anyOf":[{"type":"array"},{"type":"object","properties":{"id":{"type":"integer"},"run_id":{"type":"integer"},"kind":{"type":"string"},"kind_label":{"type":"string"},"status":{"type":"string"},"attempts":{"type":"integer"},"max_attempts":{"type":"integer"},"next_attempt_at":{"type":["string","null"]},"payload":{"type":"array","items":{}},"request_excerpt":{"type":["string","null"]},"response_excerpt":{"type":["string","null"]},"created_at":{"type":["string","null"]}},"required":["id","run_id","kind","kind_label","status","attempts","max_attempts","next_attempt_at","payload","request_excerpt","response_excerpt","created_at"]}]}},"response_json":{"type":["array","null"],"items":{}}},"required":["id","flow_token","contact","status","origin","node_id","automation_run_id","conversation_id","version","version_id","output_id","output_label","reason","reason_label","completed_after_expiry","partial","last_screen_id","sent_at","delivered_at","read_at","responded_at","expires_at","answers","effects","response_json"]}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read"}},"/forms/families/{familyId}/versions":{"get":{"operationId":"whatsappForm.versions","description":"**Permiso requerido:** `conversations:read`\n\nLista las versiones de un formulario de tu cuenta, de la más nueva a la más vieja, con su estado, si es la vigente y cuántas respuestas recibió cada una. `{familyId}` es el `family_id` del formulario. Pagina con `perPage` (1 a 100, 25 por defecto). Responde 404 si el formulario no existe o no es de tu cuenta.","summary":"GET /forms/families/{familyId}/versions","tags":["WhatsappForm"],"parameters":[{"name":"familyId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"version":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string"},"is_current":{"type":"boolean"},"published_at":{"type":["string","null"]},"deprecated_at":{"type":["string","null"]},"meta_flow_id":{"type":["string","null"]},"retained_reason":{"type":["string","null"]},"responses":{"type":"integer"},"templates":{"type":"integer"}},"required":["id","version","name","status","is_current","published_at","deprecated_at","meta_flow_id","retained_reason","responses","templates"]}},"links":{"type":"object","properties":{"first":{"type":["string","null"]},"last":{"type":["string","null"]},"prev":{"type":["string","null"]},"next":{"type":["string","null"]}},"required":["first","last","prev","next"]},"meta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":["string","null"]},"label":{"type":"string"},"active":{"type":"boolean"}},"required":["url","label","active"]}},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","from","last_page","links","path","per_page","to","total"]}},"required":["data","links","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read"}},"/forms/families/{familyId}/definition":{"get":{"operationId":"whatsappForm.definition","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve la definición de un formulario: la de la versión publicada o, si todavía no hay ninguna, la de la versión más nueva. `{familyId}` es el `family_id` del formulario, no el `id` de una versión. Responde 404 si el formulario no existe o no es de tu cuenta.","summary":"GET /forms/families/{familyId}/definition","tags":["WhatsappForm"],"parameters":[{"name":"familyId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"family_id":{"type":"integer"},"form_id":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string"},"version":{"type":"integer"},"definition":{"anyOf":[{"type":"array"},{"type":"object","properties":{"screens":{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}},"required":["screens"]}]}},"required":["family_id","form_id","name","status","version","definition"]}},"required":["data"]},{"type":"object","properties":{"data":{"type":"null"}},"required":["data"]}]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read"}},"/forms/{id}":{"get":{"operationId":"whatsappForm.show","description":"**Permiso requerido:** `conversations:read`\n\nDevuelve una versión de un formulario de tu cuenta con su definición y su detalle. `{id}` es el `id` de la versión (el de las filas de `GET /forms`), no el `family_id`. Trae además `lint` (lo que falta corregir antes de publicar), `versions` (las versiones del formulario) y `numbers` (los números donde vive). Responde 404 si la versión no existe o no es de tu cuenta.","summary":"GET /forms/{id}","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WhatsappFormResource"},"lint":{"type":"array","items":{}},"versions":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappForm"}},"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["data","lint","versions","numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read"},"put":{"operationId":"whatsappForm.update","description":"**Permiso requerido:** `conversations:write`\n\nGuarda la definición de un borrador. `{id}` es el `id` de la versión. Envía `definition` con `screens` (cada pantalla con `id` de texto y `items`; cada bloque con `type`, y las preguntas con `name`) y, si quieres, `name` y `expected_updated_at`. Una definición con la forma rota responde 422 con el error en su ruta. Lo incompleto (sin título, sin bloques, etiquetas vacías) se guarda y la respuesta trae en `lint` lo que falta corregir. Responde 409 `PUBLISHED` si la versión ya está publicada (crea otra con `POST /forms/{id}/versions`) y 409 `STALE` si `expected_updated_at` no es el último guardado. Responde 404 si no existe o no es de tu cuenta.","summary":"PUT /forms/{id}","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveWhatsappFormRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WhatsappFormResource"},"lint":{"type":"array","items":{}}},"required":["data","lint"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write"},"delete":{"operationId":"whatsappForm.destroy","description":"**Permiso requerido:** `conversations:write`\n\nElimina un borrador. `{id}` es el `id` de la versión. Un formulario publicado no se elimina: responde 409 `PUBLISHED`. Responde 404 si la versión no existe o no es de tu cuenta.","summary":"DELETE /forms/{id}","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"array","items":{}}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","const":"PUBLISHED"},"message":{"type":"string","const":"Un formulario publicado no se elimina; se depreca."}},"required":["error","message"]}}}}},"x-fc-permission":"conversations:write"}},"/forms/{id}/numbers":{"get":{"operationId":"whatsappForm.numbersIndex","description":"**Permiso requerido:** `conversations:read`\n\nLista los números de WhatsApp Cloud donde vive una versión de formulario de tu cuenta y el estado de cada uno (`draft`, `publishing`, `published` o `failed`). El primero es el número con el que se creó. `{id}` es el `id` de la versión. Responde 404 si la versión no existe o no es de tu cuenta.","summary":"GET /forms/{id}/numbers","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:read"},"post":{"operationId":"whatsappForm.addNumber","description":"**Permiso requerido:** `conversations:write`\n\nSuma un número de WhatsApp Cloud a una versión de formulario. `{id}` es el `id` de la versión y `device_id` el número de tu cuenta. Si la versión ya está publicada, se publica en ese número de inmediato. Responde `numbers` con el estado de cada número; si el número no es de tu cuenta o no es WhatsApp Cloud responde 422 `NUMBER_NOT_ELIGIBLE`. Puedes llamarla hasta 30 veces por minuto.","summary":"POST /forms/{id}/numbers","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFormNumberRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"422":{"$ref":"#/components/responses/ValidationException"}},"x-fc-permission":"conversations:write"}},"/forms/{id}/versions":{"post":{"operationId":"whatsappForm.storeVersion","description":"**Permiso requerido:** `conversations:write`\n\nCrea la versión siguiente de un formulario publicado, como borrador, para poder cambiarlo. `{id}` es el `id` de la versión desde la que partes. Responde 201 con la versión nueva, o 200 con `created: false` si el formulario ya tenía un borrador (ese borrador es la respuesta). Responde 404 si la versión no existe o no es de tu cuenta.","summary":"POST /forms/{id}/versions","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:write"}},"/forms/{id}/sync":{"post":{"operationId":"whatsappForm.sync","description":"**Permiso requerido:** `conversations:write`\n\nValida una versión en Meta sin publicarla. `{id}` es el `id` de la versión. Responde la versión con `lint` y lo que Meta observó. Si Meta rechaza la llamada responde 502 `META`. Responde 404 si no existe o no es de tu cuenta. Puedes llamarla hasta 30 veces por minuto.","summary":"POST /forms/{id}/sync","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WhatsappFormResource"},"lint":{"type":"array","items":{}},"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["data","lint","numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:write"}},"/forms/{id}/publish":{"post":{"operationId":"whatsappForm.publish","description":"**Permiso requerido:** `conversations:write`\n\nPublica una versión en Meta; la publicación es inmediata. `{id}` es el `id` de la versión. Si la definición tiene errores responde 422 `LINT` con la lista; si Meta rechaza la llamada, 502 `META`. Los otros números del formulario se publican en segundo plano: consulta su estado en `GET /forms/{id}/numbers`. Responde 404 si no existe o no es de tu cuenta. Puedes llamarla hasta 30 veces por minuto.","summary":"POST /forms/{id}/publish","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WhatsappFormResource"},"lint":{"type":"array","items":{}},"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["data","lint","numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:write"}},"/forms/{id}/numbers/{deviceId}":{"delete":{"operationId":"whatsappForm.removeNumber","description":"**Permiso requerido:** `conversations:write`\n\nQuita un número de una versión de formulario: deja de enviarse por él. `{id}` es el `id` de la versión y `{deviceId}` el número de tu cuenta. El número con el que se creó el formulario no se quita: responde 422 `PRIMARY_NUMBER`. Responde 404 si la versión o el número no existen o no son de tu cuenta.","summary":"DELETE /forms/{id}/numbers/{deviceId}","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"deviceId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":[""]}},"required":["message"]}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","const":"PRIMARY_NUMBER"},"message":{"type":"string","const":"El número con el que se creó el formulario no se puede quitar."}},"required":["error","message"]}}}}},"x-fc-permission":"conversations:write"}},"/forms/{id}/numbers/retry":{"post":{"operationId":"whatsappForm.retryNumbers","description":"**Permiso requerido:** `conversations:write`\n\nReintenta publicar los números que fallaron o que aún no se publicaron en una versión ya publicada. `{id}` es el `id` de la versión. Responde `numbers` con el estado de cada número. Responde 404 si no existe o no es de tu cuenta.","summary":"POST /forms/{id}/numbers/retry","tags":["WhatsappForm"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","prefixItems":[{"type":"object","properties":{"device_id":{},"primary":{"type":"boolean"},"status":{"type":"string"},"error":{"type":"string"}},"required":["device_id","primary","status","error"]}],"minItems":1,"maxItems":1}},"required":["numbers"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"}},"x-fc-permission":"conversations:write"}},"/contacts/{contact}/message/form":{"post":{"operationId":"whatsappFormSend.store","description":"$129","summary":"Enviar un formulario","tags":["WhatsappFormSend"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendWhatsappFormRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"anyOf":[{"$ref":"#/components/schemas/PublicMessageResource"},{"type":"null"}]}},"required":["message"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"$ref":"#/components/responses/AuthorizationException"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["form_not_found"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}]}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]},{"type":"object","properties":{"error":{"type":"string","enum":["window_closed","antiblock_duplicate_content","antiblock_unanswered_limit","recipient_unsupported"]},"message":{"type":"string"}},"required":["error","message"]},{"type":"object","properties":{"error":{"type":"string","enum":["device_unavailable","not_sent","number_not_eligible","form_not_published","form_not_on_number","recipient_unreachable","window_closed"]},"message":{"type":"string"}},"required":["error","message"]}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["rate_limited"]},"message":{"type":"string"}},"required":["error","message"]}}},"headers":{"Retry-After":{"required":true,"schema":{"type":"integer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","enum":["Server Error"]}},"required":["message"]}}}}},"x-fc-permission":"conversations:send","x-fc-proposito":"Sirve para pedirle datos a un contacto dentro de WhatsApp, por ejemplo para una inscripción o una encuesta, con un formulario que ya publicaste."}}},"components":{"securitySchemes":{"http":{"type":"http","scheme":"bearer"}},"schemas":{"AddFormNumberRequest":{"type":"object","properties":{"device_id":{"type":"integer","minimum":1}},"required":["device_id"],"title":"AddFormNumberRequest"},"BroadcastContactResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"whatsapp_id":{"type":"string"},"email":{"type":"string"},"image":{"type":"string"}},"required":["id","name","phone","whatsapp_id","email","image"],"title":"BroadcastContactResource"},"BroadcastCostResource":{"type":"object","properties":{"broadcast_id":{"type":"string"},"currency":{"type":"string","const":"USD"},"is_partial":{"type":"boolean"},"estimate":{"type":["object","null"],"properties":{"category":{"type":["string","null"]},"currency":{"type":"string"},"contacts":{"type":"integer"},"unpriced_contacts":{"type":"integer"},"total":{"type":"number"},"per_market":{"type":"array","items":{"type":"object","properties":{"market":{"type":"string"},"contacts":{"type":"integer"},"rate":{"type":["number","null"]},"cost":{"type":"number"}},"required":["market","contacts","rate","cost"]}},"rates_updated_at":{"type":["string","null"]},"computed_at":{"type":["string","null"]}},"required":["category","currency","contacts","unpriced_contacts","total","per_market","rates_updated_at","computed_at"]},"computed":{"type":"object","properties":{"total":{"type":"number"},"sent":{"type":"integer","const":0},"billed":{"type":"integer","const":0},"free":{"type":"integer","const":0},"pending_price":{"type":"integer","const":0},"no_data":{"type":"integer","const":0},"category":{"type":["null","string","integer","object"]},"per_market":{"type":"array","items":{"type":"object","properties":{"market":{"type":"string"},"contacts":{"type":"integer"},"rate":{"type":["number","null"]},"cost":{"type":"number"}},"required":["market","contacts","rate","cost"]}}},"required":["total","sent","billed","free","pending_price","no_data","category","per_market"]},"rates_updated_at":{"type":["string","null"]}},"required":["broadcast_id","currency","is_partial","estimate","computed","rates_updated_at"],"title":"BroadcastCostResource"},"BroadcastCostTiersResource":{"type":"object","properties":{"tiers":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}]},"rates_updated_at":{"type":["string","null"]}},"required":["tiers","rates_updated_at"],"title":"BroadcastCostTiersResource"},"BroadcastFolderResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"broadcasts_count":{"anyOf":[{"type":"string"},{"type":"integer","enum":[0]}]}},"required":["id","name","broadcasts_count"],"title":"BroadcastFolderResource"},"BroadcastMessageResource":{"type":"object","properties":{"contact_id":{"type":"string"},"contact_name":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"contact_phone":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"contact_image":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"message_status":{"type":["string","null"]},"message_info":{"type":"object","properties":{"message":{"anyOf":[{"type":"string"},{}]},"error_code":{"anyOf":[{"type":"string"},{}]},"error":{"anyOf":[{"type":"string"},{}]},"error_category":{"anyOf":[{"type":["string","null"]},{}]}},"required":["message","error_code","error","error_category"],"additionalProperties":{}},"skip_reason":{"type":["string","null"]},"skipped_at":{"type":["string","null"]},"recipient_state":{"type":"string"},"sent_at":{"type":["string","null"]}},"required":["contact_id","contact_name","contact_phone","contact_image","message_status","message_info","skip_reason","skipped_at","recipient_state","sent_at"],"title":"BroadcastMessageResource"},"BroadcastResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"device_id":{"type":["integer","null"]},"template_id":{"anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"template":{"type":["string","null"]},"folder":{"type":["object","null"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"value":{"type":["array","null"],"items":{}},"template_button_flows":{"type":["array","null"],"items":{}},"included_tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}},"excluded_tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}},"some_tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}},"countries":{"type":["array","null"],"items":{}},"kanban_setting_id":{"type":["integer","null"]},"kanban_stage_ids":{"type":["array","null"],"items":{}},"only_stagnant":{"type":"boolean"},"lead_score_categories":{"type":["array","null"],"items":{}},"lead_score_min":{"type":["integer","null"]},"lead_score_max":{"type":["integer","null"]},"exclude_never_replied":{"type":"boolean"},"date_from":{"type":"string"},"date_to":{"type":"string"},"send_at":{"type":"string"},"contacts_count":{"type":["string","integer","null"]},"delivered_messages_count":{"type":"null"},"readed_messages_count":{"type":"null"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"status":{"$ref":"#/components/schemas/BroadcastStatusEnum"},"shipping_speed":{"$ref":"#/components/schemas/BroadcastShippingSpeedEnum"},"risk_acceptance":{"type":["object","null"],"properties":{"accepted_by_name":{"type":["string","null"]},"accepted_at":{"type":"string"},"audience_count":{"type":["integer","null"]},"provider":{"type":["string","null"]},"risk_codes":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}]}},"required":["accepted_by_name","accepted_at","audience_count","provider","risk_codes"]},"missing_data_audit":{"type":["object","null"],"properties":{"audience_count":{"type":"integer"},"affected_count":{"type":"integer"},"items":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}]},"unknown_custom_fields":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}]}},"required":["audience_count","affected_count","items","unknown_custom_fields"]},"smart_send":{"type":"boolean"},"smart_send_state":{"type":["object","null"],"properties":{"batch_size":{"type":"string"},"pages_per_batch":{"type":"string"},"current_batch":{"type":"string"},"total_batches":{"type":"string"},"quality":{"type":"string"},"quality_baseline":{"type":"string"},"checked_at":{"type":"string"},"resume_page":{"type":"string"},"page_size":{"type":"string"},"total_pages":{"type":"string"},"paused_at":{"type":"string"},"pause_reason":{"type":"string"},"quality_read_failures":{"type":"string"},"cancelled_at":{"type":"string"}},"required":["batch_size","pages_per_batch","current_batch","total_batches","quality","quality_baseline","checked_at","resume_page","page_size","total_pages","paused_at","pause_reason","quality_read_failures","cancelled_at"]},"failure_reason":{"type":["object","null"],"properties":{"reason":{"type":["string","null"]}},"required":["reason"]},"send_mode":{"$ref":"#/components/schemas/BroadcastSendModeEnum"},"protect_template_category":{"type":"boolean"}},"required":["id","name","device_id","template_id","template","folder","value","template_button_flows","included_tags","excluded_tags","some_tags","countries","kanban_setting_id","kanban_stage_ids","only_stagnant","lead_score_categories","lead_score_min","lead_score_max","exclude_never_replied","date_from","date_to","send_at","contacts_count","delivered_messages_count","readed_messages_count","created_at","updated_at","status","shipping_speed","risk_acceptance","missing_data_audit","smart_send","smart_send_state","failure_reason","send_mode","protect_template_category"],"title":"BroadcastResource"},"BroadcastSendModeEnum":{"type":"string","enum":["now","schedule","after_approval"],"title":"BroadcastSendModeEnum"},"BroadcastShippingSpeedEnum":{"type":"integer","enum":[0,1,2],"title":"BroadcastShippingSpeedEnum"},"BroadcastStatusEnum":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9],"title":"BroadcastStatusEnum"},"BroadcastsResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"device_id":{"type":"string"},"template_id":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"folder_id":{"type":"string"},"value":{"type":"string"},"date_from":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"date_to":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"send_at":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"contacts_count":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"status":{"type":"string"},"shipping_speed":{"type":"string"},"delivered_messages_count":{"type":["string","null"]},"readed_messages_count":{"type":["string","null"]},"replied_messages_count":{"type":["string","null"]},"failure_reason":{"type":["object","null"],"properties":{"reason":{"type":["string","null"]}},"required":["reason"]},"send_mode":{"type":"string"},"protect_template_category":{"type":"boolean"}},"required":["id","name","device_id","template_id","folder_id","value","date_from","date_to","send_at","contacts_count","created_at","updated_at","status","shipping_speed","delivered_messages_count","readed_messages_count","replied_messages_count","failure_reason","send_mode","protect_template_category"],"title":"BroadcastsResource"},"BulkMoveStageRequest":{"type":"object","properties":{"contact_ids":{"type":"array","items":{"type":"integer"},"minItems":1,"maxItems":200},"stage_id":{"type":"integer"}},"required":["contact_ids","stage_id"],"title":"BulkMoveStageRequest"},"BulkRemoveStageRequest":{"type":"object","properties":{"contact_ids":{"type":"array","items":{"type":"integer"},"minItems":1,"maxItems":200}},"required":["contact_ids"],"title":"BulkRemoveStageRequest"},"ContactCustomFieldResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"contact_count":{"type":"string"}},"required":["id","name","description","type","value","created_at","updated_at","contact_count"],"title":"ContactCustomFieldResource"},"ContactFlowListResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"running":{"type":"boolean"},"created_at":{"type":["string","null"]},"last_run_at":{"type":["string","null"]}},"required":["id","name","running","created_at","last_run_at"],"title":"ContactFlowListResource"},"ContactKanbanStageBoardResource":{"type":"object","properties":{"kanban_setting_id":{"type":"string"},"kanban_name":{"type":"string"},"current_stage_id":{"type":"string"},"value_custom_field_id":{"type":"string"},"profit_custom_field_id":{"type":"string"},"stages":{"type":"string"}},"required":["kanban_setting_id","kanban_name","current_stage_id","value_custom_field_id","profit_custom_field_id","stages"],"title":"ContactKanbanStageBoardResource"},"ContactLeadScoreResource":{"type":"object","properties":{"score":{"type":"string"},"signals_count":{"type":"string"},"category":{"type":"string"},"confidence":{"type":"string"},"disqualified":{"type":"string"},"disqualified_at":{"type":"string"},"disqualification_reasons":{"type":"string"},"updated_at":{"type":["string","null"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/LeadScoreEventResource"}},"next_cursor":{"type":"string"},"has_more":{"type":"boolean"}},"required":["score","signals_count","category","confidence","disqualified","disqualified_at","disqualification_reasons","updated_at","events","next_cursor","has_more"],"title":"ContactLeadScoreResource"},"ContactNoteResource":{"type":"object","properties":{"id":{"type":"integer"},"contact_id":{"type":"integer"},"author_id":{"type":["integer","null"]},"author_name":{},"body":{"type":"string"},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]}},"required":["id","contact_id","author_id","author_name","body","created_at","updated_at"],"title":"ContactNoteResource"},"ContactResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"whatsapp_id":{"type":"string"},"whatsapp_username":{"type":["string","null"]},"has_phone":{"type":"boolean"},"country_code":{"type":"string"},"status":{"type":"integer"},"image":{"type":"string"},"notes":{"type":["string","null"],"deprecated":true},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/ContactCustomFieldResource"}},"created_at":{"type":["string","null"],"format":"date-time"},"active_conversation":{"type":"integer"},"favorite":{"type":"integer"},"unread_messages":{"type":"integer"},"manually_unread":{"type":"boolean"},"last_message":{"type":"object","properties":{"text":{"type":"string"},"file":{"type":"string"},"date":{"type":"string"},"type":{"type":"string"},"own":{"type":"string"},"deleted_at":{"type":"string"},"deleted_scope":{"type":"string"}},"required":["text","file","date","type","own","deleted_at","deleted_scope"]},"device_id":{"type":["integer","null"]},"adviser_id":{"type":["integer","null"]},"paused_at":{"type":["string","null"]},"mac_date":{"type":["string","null"]},"is_mac_inactive":{"type":"boolean","description":"`true` si el contacto es inactivo por el límite de contactos activos en el momento de la consulta: tu cuenta está en bloqueo (`state` = `enforcing` en `GET /mac/status`) y el contacto todavía no es un contacto activo del ciclo actual. Viene en `GET /contacts`, `GET /contacts/{contact}` y `GET /conversations`."},"ai_assistant_name":{"type":["string","null"]},"stage_since":{"type":"string"},"is_stagnant":{"type":"boolean"},"lead_score":{"type":"object","properties":{"score":{"type":"integer"},"signals_count":{"type":"integer"},"category":{"type":"string"},"confidence":{"type":"string"},"disqualified":{"type":"boolean"},"disqualified_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]}},"required":["score","signals_count","category","confidence","disqualified","disqualified_at","updated_at"]},"name_mismatch":{"type":["array","null"],"items":{}}},"required":["id","name","email","phone","whatsapp_id","has_phone","country_code","status","image","notes","created_at","active_conversation","favorite","unread_messages","device_id","adviser_id","paused_at","mac_date","ai_assistant_name"],"title":"ContactResource"},"ContactTagResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"color":{"type":"string"},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]},"contact_count":{"type":"string"},"assigned_at":{"type":["string","null"]},"last_updated":{"type":["string","null"]}},"required":["id","name","description","color","created_at","updated_at","contact_count","assigned_at","last_updated"],"title":"ContactTagResource"},"CursorPaginator":{"type":"object","properties":{"data":{"type":"string"},"path":{"type":["string","null"]},"per_page":{"type":"integer"},"next_cursor":{"type":["string","null"]},"next_page_url":{"type":["string","null"]},"prev_cursor":{"type":["string","null"]},"prev_page_url":{"type":["string","null"]}},"required":["data","path","per_page","next_cursor","next_page_url","prev_cursor","prev_page_url"],"title":"CursorPaginator"},"CustomFieldResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/CustomFieldTypeEnum"},"description":{"type":["string","null"]},"contact_count":{"type":"integer"},"created_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","type","description","created_at"],"title":"CustomFieldResource"},"CustomFieldTypeEnum":{"type":"integer","enum":[0,1,2,3,4],"title":"CustomFieldTypeEnum"},"FlowResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"uuid":{"type":"string"},"first_node_uuid":{"type":"string"},"enable":{"type":"string"},"valid":{"type":"string"},"executions":{"anyOf":[{"type":"string"},{"type":"integer","enum":[0]}]},"created_at":{"type":"string"},"updated_at":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"nodes_count":{"anyOf":[{"type":"string"},{"type":"integer","enum":[0]}]},"trigger_uuid":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"trigger_device_ids":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}]},"trigger_type":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"trigger_values":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}]},"trigger_is_global":{"type":"boolean"},"trigger_save_activation_phrase":{"type":"boolean"},"trigger_activation_phrase_field_id":{"type":["string","null"]},"payment_platform":{"type":["string","null"]},"payment_external_product_id":{"type":["string","null"]},"payment_event_types":{"type":["string","null"]},"payment_event_entry_nodes":{"type":["string","null"]},"default":{"type":"string"},"once_per_contact":{"type":"string"},"frequency_limit_value":{"type":"string"},"frequency_limit_unit":{"type":["string","null"]},"frequency_limit_minutes":{"type":"string"},"folder":{"$ref":"#/components/schemas/FolderResource"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/NodeResource"}},"inbound_origins":{"type":"string"},"intention_prompt":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"match_location":{"type":["string","null"]},"match_details":{"type":["string","null"]},"risk_acceptance":{"type":["object","null"],"properties":{"accepted_by_name":{"type":["string","null"]},"accepted_at":{"type":"string"},"codes":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0}]}},"required":["accepted_by_name","accepted_at","codes"]}},"required":["id","name","uuid","first_node_uuid","enable","valid","executions","created_at","updated_at","nodes_count","trigger_device_ids","trigger_type","trigger_is_global","trigger_save_activation_phrase","trigger_activation_phrase_field_id","payment_platform","payment_external_product_id","payment_event_types","payment_event_entry_nodes","default","once_per_contact","frequency_limit_value","frequency_limit_unit","frequency_limit_minutes","intention_prompt","match_location","match_details","risk_acceptance"],"title":"FlowResource"},"FolderResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"parent_id":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/FolderResource"}},"flows_count":{"type":"integer"}},"required":["id","name","parent_id"],"title":"FolderResource"},"ForwardMessageRequest":{"type":"object","properties":{"targets":{"type":"array","items":{"type":"object","properties":{"contact_id":{"type":"integer"},"device_id":{"type":"integer"}},"required":["contact_id","device_id"]},"minItems":1,"maxItems":5,"uniqueItems":true},"client_reference":{"type":["string","null"],"pattern":"^[\\x21-\\x7E]{1,64}$","maxLength":64}},"required":["targets"],"title":"ForwardMessageRequest"},"IngestLeadScoreEventsRequest":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["group_join","group_leave","group_reaction","group_poll_vote","link_click"]},"owner_user_id":{"type":"integer","minimum":1},"contact_id":{"type":["integer","null"],"minimum":1},"phone":{"type":["string","null"],"pattern":"^[0-9+\\s()\\-]+$","minLength":8,"maxLength":32},"occurred_at":{"type":"string","format":"date-time"},"external_id":{"type":"string","maxLength":255},"scope_key":{"type":["string","null"],"maxLength":255},"meta":{"type":["object","null"],"properties":{"campaign_message_uid":{"type":["string","null"],"maxLength":255}}}},"required":["signal","owner_user_id","occurred_at","external_id"]},"minItems":1,"maxItems":100}},"required":["events"],"title":"IngestLeadScoreEventsRequest"},"KanbanSettingResource":{"type":"object","properties":{"id":{"type":"integer"},"user_id":{"type":"integer"},"name":{"type":"string"},"mode":{"type":"string"},"stagnant_days":{"type":["integer","null"]},"value_custom_field_id":{"type":["integer","null"]},"profit_custom_field_id":{"type":["integer","null"]},"view_mode":{"type":"string"},"icon":{"type":["string","null"]},"description":{"type":["string","null"]},"is_primary":{"type":"boolean"},"color_by_lead_score":{"type":"boolean"},"structure":{"type":"array","items":{}},"stages":{"type":"array","items":{"$ref":"#/components/schemas/KanbanStageResource"}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","user_id","name","mode","stagnant_days","value_custom_field_id","profit_custom_field_id","view_mode","icon","description","is_primary","color_by_lead_score","structure","created_at","updated_at"],"title":"KanbanSettingResource"},"KanbanStageResource":{"type":"object","properties":{"id":{"type":"integer"},"kanban_setting_id":{"type":"integer"},"name":{"type":"string"},"position":{"type":"integer"},"contacts_count":{"type":"integer"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","kanban_setting_id","name","position","created_at","updated_at"],"title":"KanbanStageResource"},"LeadScoreDistributionResource":{"type":"object","properties":{"total":{"type":"string"},"counts":{"type":"object","properties":{"hot":{"type":"string"},"warm":{"type":"string"},"cold":{"type":"string"},"insufficient_data":{"type":"string"}},"required":["hot","warm","cold","insufficient_data"]},"thresholds":{"type":"object","properties":{"hot_threshold":{"type":"string"},"warm_threshold":{"type":"string"},"min_signals":{"type":"string"}},"required":["hot_threshold","warm_threshold","min_signals"]}},"required":["total","counts","thresholds"],"title":"LeadScoreDistributionResource"},"LeadScoreEventResource":{"type":"object","properties":{"id":{"type":"string"},"signal":{"type":"string"},"source":{"type":"string"},"raw_points":{"type":"string"},"applied_points":{"type":"string"},"cap_reason":{"type":["string","null"]},"occurred_at":{"type":["string","null"]},"actor_user_id":{"type":"string"},"reason":{"type":"string"}},"required":["id","signal","source","raw_points","applied_points","cap_reason","occurred_at"],"title":"LeadScoreEventResource"},"LeadScoreSettingsResource":{"type":"object","properties":{"hot_threshold":{"type":"integer"},"warm_threshold":{"type":"integer"},"min_signals":{"type":"integer"},"hysteresis":{"type":"integer"},"decay_steps":{"type":"array","items":{"type":"object","properties":{"days":{"type":"integer"},"points":{"type":"integer"}},"required":["days","points"]}},"decay_enabled":{"type":"boolean"},"rules":{"type":"array","items":{}}},"required":["hot_threshold","warm_threshold","min_signals","hysteresis","decay_steps","decay_enabled","rules"],"title":"LeadScoreSettingsResource"},"LengthAwarePaginator":{"type":"object","properties":{"current_page":{"type":"integer"},"data":{"type":"string"},"first_page_url":{"type":"string"},"from":{"type":["integer","null"]},"last_page":{"type":"integer"},"last_page_url":{"type":"string"},"links":{"type":"object","additionalProperties":{}},"next_page_url":{"type":"string"},"path":{"type":["string","null"]},"per_page":{"type":"integer"},"prev_page_url":{"type":["string","null"]},"to":{"type":["integer","null"]},"total":{"type":"integer"}},"required":["current_page","data","first_page_url","from","last_page","last_page_url","links","next_page_url","path","per_page","prev_page_url","to","total"],"title":"LengthAwarePaginator"},"MessageOriginEnum":{"type":"integer","enum":[0,1,2,3],"title":"MessageOriginEnum"},"MessageResource":{"type":"object","properties":{"chat_id":{"type":"string"},"contact_id":{"anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"content":{"anyOf":[{"type":"array"},{"type":"string","enum":[""]}]},"device_id":{"anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"error_code":{"type":"string"},"file":{"type":"string"},"forwarded":{"type":"integer"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"id":{"type":"integer"},"origin":{"anyOf":[{"$ref":"#/components/schemas/MessageOriginEnum"},{"type":"string","enum":[""]}]},"origin_id":{"anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"own":{"type":"integer"},"reference_message":{"type":["string","null"]},"reference_message_uid":{"type":["string","null"]},"is_quotable":{"type":"boolean"},"status":{"anyOf":[{"$ref":"#/components/schemas/MessageStatusEnum"},{"type":"null"}]},"temporal_uuid":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"text":{"type":"string"},"time":{"type":["string","null"]},"type":{"anyOf":[{"$ref":"#/components/schemas/MessageTypeEnum"},{"type":"null"}]},"uid":{"type":"string"},"info":{"anyOf":[{"type":"array"},{"type":"string","enum":[""]}]},"user_id":{"type":"integer"},"deleted_at":{"type":["string","null"]},"deleted_scope":{"type":["string","null"]},"poll_results":{"type":"string"},"event_rsvps":{"type":"string"},"form_answers":{"type":"string"},"reactions":{"type":"array","items":{}},"file_original_name":{"type":["string","null"]},"client_reference":{"type":["string","null"]}},"required":["chat_id","contact_id","content","device_id","error_code","file","forwarded","group_id","id","origin","origin_id","own","reference_message","reference_message_uid","is_quotable","status","temporal_uuid","text","time","type","uid","info","user_id","deleted_at","deleted_scope","reactions","file_original_name","client_reference"],"title":"MessageResource"},"MessageStatusEnum":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10],"title":"MessageStatusEnum"},"MessageTemplateStatusEnum":{"type":"string","enum":["PENDING","APPROVED","REJECTED","PENDING_DELETION","PAUSED","DISABLED","ARCHIVED"],"title":"MessageTemplateStatusEnum"},"MessageTemplateTypeEnum":{"type":"string","enum":["text","image","document","video","location","default"],"title":"MessageTemplateTypeEnum"},"MessageTypeEnum":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24],"title":"MessageTypeEnum"},"MoveBroadcastsToFolderRequest":{"type":"object","properties":{"broadcast_ids":{"type":"array","items":{"type":"integer"},"minItems":1,"maxItems":100},"folder_id":{"type":["integer","null"]}},"required":["broadcast_ids"],"title":"MoveBroadcastsToFolderRequest"},"MoveContactStageRequest":{"type":"object","properties":{"contact_id":{"type":"integer"},"stage_id":{"type":"integer"}},"required":["contact_id","stage_id"],"title":"MoveContactStageRequest"},"NodeResource":{"type":"object","properties":{"uuid":{"type":"string"},"flow_id":{"type":"string"},"type":{"type":"integer"},"action":{"type":"string"},"value":{"type":"string"},"next_uuid":{"type":"string"}},"required":["uuid","flow_id","type","action","value","next_uuid"],"title":"NodeResource"},"PaymentEventTypeEnum":{"type":"string","enum":["approved","pending","rejected","cancelled","refunded","chargeback"],"title":"PaymentEventTypeEnum"},"PaymentProductResource":{"type":"object","properties":{"external_product_id":{"type":"string"},"name":{"type":["string","null"]}},"required":["external_product_id","name"],"title":"PaymentProductResource"},"PublicMessageResource":{"type":"object","properties":{"id":{"type":"integer"},"contact_id":{"type":["integer","null"]},"device_id":{"type":["integer","null"]},"direction":{"type":"string","enum":["outbound","inbound"]},"type":{"type":"string","enum":["text","image","video","document","sticker","contact","audio","note","action","invalid","interactive","location","voice_call","video_call","event","button","template","notification","option_list","template_button_reply","poll","whatsapp_form","call_permission_request","call_permission_reply","request_contact_info"]},"status":{"type":["string","null"],"enum":["sent","delivered","read","failed","queued",null]},"error":{"type":["object","null"],"properties":{"code":{"type":["integer","null"]},"title":{"type":["string","null"]},"reason":{"type":["string","null"]}},"required":["code","title","reason"]},"client_reference":{"type":["string","null"]},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]}},"required":["id","contact_id","device_id","direction","type","status","error","client_reference","created_at","updated_at"],"title":"PublicMessageResource"},"QuickReplyResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"message":{"type":"string"},"file":{"type":"string"},"type":{"$ref":"#/components/schemas/MessageTypeEnum"},"visibility":{"$ref":"#/components/schemas/QuickReplyVisibilityEnum"},"agents":{"type":"object","additionalProperties":{}},"user_id":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","message","file","type","visibility","agents","user_id","created_at","updated_at"],"title":"QuickReplyResource"},"QuickReplyVisibilityEnum":{"type":"integer","enum":[1,2,3],"title":"QuickReplyVisibilityEnum"},"RemoveContactStageRequest":{"type":"object","properties":{"contact_id":{"type":"integer"}},"required":["contact_id"],"title":"RemoveContactStageRequest"},"ReorderKanbanStagesRequest":{"type":"object","properties":{"stage_ids":{"type":"array","items":{"type":"integer"},"minItems":1,"uniqueItems":true}},"required":["stage_ids"],"title":"ReorderKanbanStagesRequest"},"SaleResource":{"type":"object","properties":{"id":{"type":"integer"},"occurred_at":{"type":"string"},"platform":{"type":"string"},"product_name":{"type":["string","null"]},"kind":{"type":"string"},"event_type":{"type":["string","null"]},"amount_minor":{"type":"integer"},"currency":{"type":"string"},"attribution":{"type":"string"},"buyer":{"type":["object","null"],"properties":{"contact_id":{"type":["integer","null"]},"name":{"type":["string","null"]},"phone":{"type":["string","null"]}},"required":["contact_id","name","phone"]}},"required":["id","occurred_at","platform","product_name","kind","event_type","amount_minor","currency","attribution","buyer"],"title":"SaleResource"},"SalesMetricsResource":{"type":"object","properties":{"window":{"type":"string"},"currencies":{"type":"string"},"distinct_buyers":{"type":"string"},"repeat_purchase_rate":{"type":"string"}},"required":["window","currencies","distinct_buyers","repeat_purchase_rate"],"title":"SalesMetricsResource"},"SaveWhatsappFormRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"definition":{"type":"object","properties":{"screens":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":64},"title":{"type":["string","null"],"maxLength":4096},"cta":{"type":["string","null"],"maxLength":4096},"next":{"type":["string","null"],"maxLength":64},"routes":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"maxLength":64},"groups":{"type":["array","null"],"items":{"type":"object","properties":{"to":{"type":["string","null"],"maxLength":64},"options":{"type":["array","null"],"items":{"type":"string","maxLength":64},"maxItems":200}}},"maxItems":50}}},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string","maxLength":64},"id":{"type":["string","null"],"maxLength":64},"label":{"type":["string","null"],"maxLength":4096},"url":{"type":["string","null"],"maxLength":4096},"src":{"type":["string","null"],"maxLength":440000},"options":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":["string","null"],"maxLength":4096},"title":{"type":["string","null"],"maxLength":4096}}},"maxItems":200},"tagMap":{"type":["array","null"],"items":{"type":["string","null"],"maxLength":191}}},"required":["type"]},"maxItems":100}},"required":["id"]},"maxItems":20}},"required":["screens"]},"expected_updated_at":{"type":["string","null"]}},"required":["definition"],"title":"SaveWhatsappFormRequest"},"SendDirectMessageRequest":{"type":"object","properties":{"device_id":{"type":"integer"},"text":{"type":"string"},"contact_id":{"type":"integer"},"file":{"type":"string","description":"Archivo del mensaje: el nombre de un archivo ya subido a tu cuenta o la URL pública de un archivo (te recomendamos `https://`), que WhatsApp o el proveedor descarga; admite hasta 4096 caracteres. Si empieza con `http`, en mayúsculas o minúsculas, tiene que ser una URL `http://` o `https://`; si no, la respuesta es 422. Consulta la sección «Enviar un archivo por URL».","pattern":"^(?:[Hh][Tt][Tt][Pp][Ss]?:\\/\\/.+|(?!\\.\\.?$)(?![Hh][Tt][Tt][Pp])[^\\/\\\\\\x00]+)$","maxLength":4096},"file_type":{"type":["string","null"],"description":"Tipo del archivo. Es obligatorio cuando `file` es una URL que no termina en una extensión reconocida; si lo envías, manda sobre la extensión. Valores: `image`, `video`, `audio`, `document`, `sticker`. Consulta la sección «Enviar un archivo por URL».","enum":["image","video","audio","document","sticker",null]},"file_name":{"type":["string","null"],"description":"Nombre con el que el contacto ve un documento, con su extensión (por ejemplo `factura.pdf`), de hasta 255 caracteres. Es obligatorio al enviar un documento por URL que no termina en una extensión de la lista. Consulta la sección «Enviar un archivo por URL».","minLength":1,"maxLength":255},"temporal_uuid":{"type":"string"},"local_id":{"type":["string","null"],"maxLength":255},"note":{"type":"boolean"},"client_reference":{"type":["string","null"],"pattern":"^[\\x21-\\x7E]{1,64}$","maxLength":64}},"required":["device_id","contact_id"],"title":"SendDirectMessageRequest"},"SendMessageRequest":{"type":"object","properties":{"phone":{"type":"string","minLength":1},"whatsapp_id":{"type":"string","minLength":1},"device_id":{"type":"integer"},"text":{"type":"string"},"contact_id":{"type":"integer"},"file":{"type":"string","description":"Archivo del mensaje: el nombre de un archivo ya subido a tu cuenta o la URL pública de un archivo (te recomendamos `https://`), que WhatsApp o el proveedor descarga; admite hasta 4096 caracteres. Si empieza con `http`, en mayúsculas o minúsculas, tiene que ser una URL `http://` o `https://`; si no, la respuesta es 422. Consulta la sección «Enviar un archivo por URL».","pattern":"^(?:[Hh][Tt][Tt][Pp][Ss]?:\\/\\/.+|(?!\\.\\.?$)(?![Hh][Tt][Tt][Pp])[^\\/\\\\\\x00]+)$","maxLength":4096},"file_type":{"type":["string","null"],"description":"Tipo del archivo. Es obligatorio cuando `file` es una URL que no termina en una extensión reconocida; si lo envías, manda sobre la extensión. Valores: `image`, `video`, `audio`, `document`, `sticker`. Consulta la sección «Enviar un archivo por URL».","enum":["image","video","audio","document","sticker",null]},"file_name":{"type":["string","null"],"description":"Nombre con el que el contacto ve un documento, con su extensión (por ejemplo `factura.pdf`), de hasta 255 caracteres. Es obligatorio al enviar un documento por URL que no termina en una extensión de la lista. Consulta la sección «Enviar un archivo por URL».","minLength":1,"maxLength":255},"temporal_uuid":{"type":"string"},"note":{"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","pattern":"\\S","minLength":1}}},"minItems":1,"maxItems":10},"reference_message_uid":{"type":["string","null"],"maxLength":255},"client_reference":{"type":["string","null"],"pattern":"^[\\x21-\\x7E]{1,64}$","maxLength":64},"link_preview":{"type":"boolean"},"link_preview_meta":{"type":"object","properties":{"url":{"type":"string","format":"uri","maxLength":2048},"title":{"type":["string","null"],"maxLength":200},"description":{"type":["string","null"],"maxLength":500},"image_url":{"type":["string","null"],"format":"uri","maxLength":2048},"domain":{"type":"string","maxLength":253}}}},"required":["device_id","contact_id"],"title":"SendMessageRequest"},"SendWhatsappFormRequest":{"type":"object","properties":{"form_id":{"type":"integer","minimum":1},"device_id":{"type":"integer","minimum":1},"text":{"type":"string","minLength":1,"maxLength":1024},"button_text":{"type":"string","minLength":1,"maxLength":30},"client_reference":{"type":["string","null"],"pattern":"^[\\x21-\\x7E]{1,64}$","maxLength":64}},"required":["form_id","device_id"],"title":"SendWhatsappFormRequest"},"StoreBroadcastFolderRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":255}},"required":["name"],"title":"StoreBroadcastFolderRequest"},"StoreContactCardRequest":{"type":"object","properties":{"device_id":{"type":"integer"},"contact_card_ids":{"type":"array","items":{"type":"integer"},"minItems":1,"maxItems":5,"uniqueItems":true},"client_reference":{"type":["string","null"],"pattern":"^[\\x21-\\x7E]{1,64}$","maxLength":64}},"required":["device_id","contact_card_ids"],"title":"StoreContactCardRequest"},"StoreContactNoteRequest":{"type":"object","properties":{"body":{"type":"string","maxLength":2000}},"required":["body"],"title":"StoreContactNoteRequest"},"StoreContactRequest":{"type":"object","properties":{"phone":{"type":"string"},"whatsapp_id":{"type":"string"},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"image":{"type":["string","null"]},"deviceId":{"type":["integer","null"]}},"title":"StoreContactRequest"},"StoreFolderRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"parent_id":{"type":["integer","null"]}},"required":["name"],"title":"StoreFolderRequest"},"StoreKanbanSettingRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":50},"mode":{"type":"string","enum":["tags","stages"]},"structure":{"type":["array","null"],"items":{"type":"object","properties":{"tag_id":{"type":"integer"},"position":{"type":"integer","minimum":0}},"required":["tag_id","position"]},"maxItems":15},"stages":{"type":["array","null"],"items":{"type":"object","properties":{"name":{"type":"string","maxLength":50}}},"maxItems":15},"stagnant_days":{"type":["integer","null"],"minimum":1,"maximum":65535},"view_mode":{"type":["string","null"],"enum":["compact","extended",null]},"icon":{"type":["string","null"],"enum":["target","filter","trending-up","users","briefcase","shopping-cart","heart","star","flag","rocket","layers","zap",null]},"description":{"type":["string","null"],"maxLength":200},"is_primary":{"type":"boolean"},"color_by_lead_score":{"type":"boolean"}},"required":["name"],"title":"StoreKanbanSettingRequest"},"StoreKanbanStageRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":50},"after_stage_id":{"type":["integer","null"]}},"required":["name"],"title":"StoreKanbanStageRequest"},"StoreLeadScoreAdjustmentRequest":{"type":"object","properties":{"delta":{"type":"integer","minimum":-100,"maximum":100},"reason":{"type":"string","minLength":3,"maxLength":255}},"required":["delta","reason"],"title":"StoreLeadScoreAdjustmentRequest"},"StoreMessageReactionRequest":{"type":"object","properties":{"emoji":{"type":"string","maxLength":32}},"required":["emoji"],"title":"StoreMessageReactionRequest"},"StoreMessageTemplateRequest":{"type":"object","properties":{"name":{"type":"string"},"language_code":{"type":"string","enum":["af","sq","ar","ar_EG","ar_AE","ar_LB","ar_MA","ar_QA","az","be_BY","bn","bn_IN","bg","ca","zh_CN","zh_HK","zh_TW","hr","cs","da","prs_AF","nl","nl_BE","en","en_GB","en_US","en_AE","en_AU","en_CA","en_GH","en_IE","en_IN","en_JM","en_MY","en_NZ","en_QA","en_SG","en_UG","en_ZA","et","fil","fi","fr","fr_BE","fr_CA","fr_CH","fr_CI","fr_MA","ka","de","de_AT","de_CH","el","gu","ha","he","hi","hu","id","ga","it","ja","kn","kk","rw_RW","ko","ky_KG","lo","lv","lt","mk","ms","ml","mr","nb","ps_AF","fa","pl","pt_BR","pt_PT","pa","ro","ru","sr","si_LK","sk","sl","es","es_AR","es_CL","es_CO","es_CR","es_DO","es_EC","es_HN","es_MX","es_PA","es_PE","es_ES","es_UY","sw","sv","ta","te","th","tr","uk","ur","uz","vi","zu"]},"category":{"type":"string","enum":["UTILITY","MARKETING","AUTHENTICATION"]},"type":{"type":"string","enum":["text","image","document","video","location","default"]},"header":{"type":["string","null"]},"file":{"type":"string"},"body":{"type":"string"},"params":{"type":["array","null"],"items":{"type":"string"}},"footer":{"type":["string","null"]},"buttons":{"type":["array","null"],"items":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string","enum":["QUICK_REPLY","URL","PHONE_NUMBER"]},"url":{"type":"string","format":"uri"},"phone_number":{"type":"string"}}},"maxItems":3}},"required":["name","language_code","category","type","body"],"title":"StoreMessageTemplateRequest"},"StoreWebhookSubscriptionRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","maxLength":2048},"description":{"type":["string","null"],"maxLength":255},"events":{"type":"array","items":{"type":"string","enum":["message.received","flow.completed","broadcast.finished","contact.stage_changed","message.status_changed","conversation.closed","conversation.assigned","contact.tag_added","broadcast.paused","contact.tag_removed","contact.created","template.status_changed","flow.failed","whatsapp_form.completed","*"]},"minItems":1,"maxItems":15,"uniqueItems":true}},"required":["url","events"],"title":"StoreWebhookSubscriptionRequest"},"StoreWhatsappFormRequest":{"type":"object","properties":{"device_id":{"type":"integer","minimum":1},"device_ids":{"type":"array","items":{"type":"integer","minimum":1},"maxItems":50},"template_key":{"type":"string"}},"required":["device_id","template_key"],"title":"StoreWhatsappFormRequest"},"TagResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":["string","null"]},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]},"contact_count":{"anyOf":[{"type":"string"},{"type":"integer","minimum":0}]}},"required":["id","name","description","color","created_at","updated_at","contact_count"],"title":"TagResource"},"TemplateResource":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"text":{"type":"string"},"header":{"type":"string"},"footer":{"type":"string"},"observation":{"type":"string"},"uid":{"type":"string"},"category":{"type":"string"},"type":{"anyOf":[{"$ref":"#/components/schemas/MessageTemplateTypeEnum"},{"type":"string","enum":[""]}]},"status":{"anyOf":[{"$ref":"#/components/schemas/MessageTemplateStatusEnum"},{"type":"string","enum":[""]}]},"language_code":{"type":"string"},"upload_session_id":{"type":"string"},"header_handle":{"type":"string"},"file":{"type":"string"},"params":{"anyOf":[{"type":"array"},{"type":"string","enum":[""]}]},"buttons":{"anyOf":[{"type":"array"},{"type":"string","enum":[""]}]},"user_id":{"type":"integer"},"device_id":{"type":"integer"},"created_at":{"type":["string","null"],"format":"date-time"},"recategorized_at":{"type":["string","null"],"format":"date-time"},"quick_reply_buttons":{"type":"array","items":{}},"waba_id":{"type":["string","null"]},"belongs_to_current_device":{"type":"boolean"}},"required":["id","name","text","header","footer","observation","uid","category","type","status","language_code","upload_session_id","header_handle","file","params","buttons","user_id","device_id","created_at","recategorized_at","quick_reply_buttons","waba_id","belongs_to_current_device"],"title":"TemplateResource"},"Ticket":{"type":"object","properties":{"id":{"type":"integer"},"user_id":{"type":"integer"},"contact_id":{"type":["integer","null"]},"title":{"type":"string"},"description":{"type":["string","null"]},"deadline":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"actor_user_id":{"type":["integer","null"]}},"required":["id","user_id","contact_id","title","description","deadline","created_at","updated_at","actor_user_id"],"title":"Ticket"},"UpdateBroadcastFolderRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":255}},"required":["name"],"title":"UpdateBroadcastFolderRequest"},"UpdateContactRequest":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"email":{"type":["string","null"],"format":"email","maxLength":255},"phone":{"type":["string","null"],"maxLength":20},"notes":{"type":["string","null"],"maxLength":2500},"status":{"type":"integer"},"adviser_id":{"type":["integer","null"]},"active_conversation":{"type":"boolean"},"favorite":{"type":"boolean"},"fixed":{"type":"boolean"},"image":{"type":["string","null"]},"can_execute_flows":{"type":"boolean"},"manually_unread":{"type":"boolean"}},"title":"UpdateContactRequest"},"UpdateFolderRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"parent_id":{"type":["integer","null"]}},"title":"UpdateFolderRequest"},"UpdateKanbanSettingRequest":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":50},"mode":{"type":"string"},"structure":{"type":["array","null"],"items":{"type":"object","properties":{"tag_id":{"type":"integer"},"position":{"type":"integer","minimum":0}},"required":["tag_id","position"]},"maxItems":15},"stagnant_days":{"type":["integer","null"],"minimum":1,"maximum":65535},"view_mode":{"type":["string","null"],"enum":["compact","extended",null]},"icon":{"type":["string","null"],"enum":["target","filter","trending-up","users","briefcase","shopping-cart","heart","star","flag","rocket","layers","zap",null]},"description":{"type":["string","null"],"maxLength":200},"is_primary":{"type":"boolean"},"color_by_lead_score":{"type":"boolean"}},"title":"UpdateKanbanSettingRequest"},"UpdateKanbanStageRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":50}},"required":["name"],"title":"UpdateKanbanStageRequest"},"UpdateMessageTemplateRequest":{"type":"object","properties":{"device_id":{"type":"integer"},"category":{"type":"string","enum":["UTILITY","MARKETING","AUTHENTICATION"]},"type":{"type":"string","enum":["text","image","document","video","location","default"]},"header":{"type":["string","null"]},"file":{"type":"string"},"body":{"type":"string"},"params":{"type":["array","null"],"items":{"type":"string"}},"footer":{"type":["string","null"]},"buttons":{"type":["array","null"],"items":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string","enum":["QUICK_REPLY","URL","PHONE_NUMBER"]},"url":{"type":"string","format":"uri"},"phone_number":{"type":"string"}}},"maxItems":3}},"required":["device_id","category","type","body"],"title":"UpdateMessageTemplateRequest"},"UpdateWebhookSubscriptionRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","maxLength":2048},"description":{"type":["string","null"],"maxLength":255},"events":{"type":"array","items":{"type":"string","enum":["message.received","flow.completed","broadcast.finished","contact.stage_changed","message.status_changed","conversation.closed","conversation.assigned","contact.tag_added","broadcast.paused","contact.tag_removed","contact.created","template.status_changed","flow.failed","whatsapp_form.completed","*"]},"minItems":1,"maxItems":15,"uniqueItems":true},"active":{"type":"boolean"}},"title":"UpdateWebhookSubscriptionRequest"},"User":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string"},"stripe_customer_id":{"type":["string","null"]},"payment_provider":{"type":["integer","null"]},"image":{"type":["string","null"]},"phone":{"type":["integer","null"]},"email_verified_at":{"type":["string","null"],"format":"date-time"},"country_code":{"type":["string","null"]},"country_name":{"type":["string","null"]},"first_login_at":{"type":["string","null"]},"last_login_at":{"type":["string","null"]},"owner_id":{"type":["integer","null"]},"advisor_scope":{"type":["integer","null"]},"admin":{"type":["boolean","null"]},"status":{"type":["integer","null"]},"payment_status":{"type":["integer","null"]},"mac_enforcement_enabled":{"type":"integer"},"timezone":{"type":"string"},"plan_name":{"type":["string","null"]},"trial":{"type":["integer","null"]},"payment_till":{"type":["string","null"],"format":"date-time"},"subscription_count":{"type":["integer","null"]},"plan_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"show_advisor_name":{"type":"integer"},"password_set_at":{"type":["string","null"]},"alert_plan_blocked_notified_at":{"type":["string","null"]},"card_prompt_pending":{"type":["integer","null"]},"trial_billing_cycle":{"type":["string","null"]},"locale":{"type":"string"},"signup_ip":{"type":["string","null"]},"trial_extended_at":{"type":["string","null"]},"selected_plan_id":{"type":["integer","null"]},"fbp":{"type":["string","null"]},"fbc":{"type":["string","null"]},"signup_user_agent":{"type":["string","null"]},"signup_url":{"type":["string","null"]},"agent_locked_at":{"type":["string","null"]},"theme":{"type":"string"},"hotmart_migrated_at":{"type":["string","null"]},"stripe_migration_incomplete_at":{"type":["string","null"]},"stripe_migration_incomplete_reason":{"type":["string","null"]}},"required":["id","name","email","stripe_customer_id","payment_provider","image","phone","email_verified_at","country_code","country_name","first_login_at","last_login_at","owner_id","advisor_scope","admin","status","payment_status","mac_enforcement_enabled","timezone","plan_name","trial","payment_till","subscription_count","plan_id","created_at","updated_at","show_advisor_name","password_set_at","alert_plan_blocked_notified_at","card_prompt_pending","trial_billing_cycle","locale","signup_ip","trial_extended_at","selected_plan_id","fbp","fbc","signup_user_agent","signup_url","agent_locked_at","theme","hotmart_migrated_at","stripe_migration_incomplete_at","stripe_migration_incomplete_reason"],"title":"User"},"UserResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"owner_id":{"type":"string"},"advisor_scope":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"required":["id","name","email","owner_id","advisor_scope","created_at","updated_at"],"title":"UserResource"},"WebhookDeliveryResource":{"type":"object","properties":{"uuid":{"type":"string"},"event_id":{"type":"string"},"event_type":{"type":"string"},"attempt":{"type":"integer"},"status":{"type":"string"},"http_status":{"type":["integer","null"]},"duration_ms":{"type":["integer","null"]},"error":{"type":["string","null"]},"next_attempt_at":{"type":["string","null"]},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]}},"required":["uuid","event_id","event_type","attempt","status","http_status","duration_ms","error","next_attempt_at","created_at","updated_at"],"title":"WebhookDeliveryResource"},"WebhookSubscriptionResource":{"type":"object","properties":{"uuid":{"type":"string"},"url":{"type":"string"},"description":{"type":["string","null"]},"events":{"type":"array","items":{}},"active":{"type":"boolean"},"inactive_reason":{"type":["string","null"]},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]}},"required":["uuid","url","description","events","active","inactive_reason","created_at","updated_at"],"title":"WebhookSubscriptionResource"},"WhatsappForm":{"type":"object","properties":{"id":{"type":"integer"},"user_id":{"type":"integer"},"workspace_id":{"type":["integer","null"]},"phone_number_id":{"type":"string"},"family_id":{"type":"integer"},"name":{"type":"string"},"category":{"type":"string"},"status":{"type":"string"},"version":{"type":"integer"},"parent_flow_id":{"type":["integer","null"]},"definition":{"type":"array","items":{}},"flow_json":{"type":["array","null"],"items":{}},"flow_json_hash":{"type":["string","null"]},"fields":{"type":["array","null"],"items":{}},"mapping":{"type":["array","null"],"items":{}},"tag_rules":{"type":["array","null"],"items":{}},"has_endpoint":{"type":"boolean"},"first_screen":{"type":["string","null"]},"first_screen_dynamic":{"type":"boolean"},"meta_flow_id":{"type":["string","null"]},"validation_errors":{"type":["array","null"],"items":{}},"lint_errors_count":{"type":"integer"},"retained_reason":{"type":["string","null"]},"published_at":{"type":["string","null"],"format":"date-time"},"deprecated_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"actor_user_id":{"type":["integer","null"]}},"required":["id","user_id","workspace_id","phone_number_id","family_id","name","category","status","version","parent_flow_id","definition","flow_json","flow_json_hash","fields","mapping","tag_rules","has_endpoint","first_screen","first_screen_dynamic","meta_flow_id","validation_errors","lint_errors_count","retained_reason","published_at","deprecated_at","created_at","updated_at","deleted_at","actor_user_id"],"title":"WhatsappForm"},"WhatsappFormResource":{"type":"object","properties":{"id":{"type":"integer"},"family_id":{"type":"integer"},"name":{"type":"string"},"label":{"type":"string"},"category":{"type":"string"},"status":{"type":"string"},"version":{"type":"integer"},"definition":{"type":"array","items":{}},"fields":{"type":["array","null"],"items":{}},"mapping":{"type":["array","null"],"items":{}},"tag_rules":{"type":["array","null"],"items":{}},"has_endpoint":{"type":"boolean"},"first_screen":{"type":["string","null"]},"first_screen_dynamic":{"type":"boolean"},"lint_errors_count":{"type":"integer"},"draft_id":{"type":"integer"},"draft_version":{"type":"integer"},"sends":{"type":"integer"},"responses":{"type":"integer"},"meta_flow_id":{"type":["string","null"]},"flow_json":{"type":["array","null"],"items":{}},"validation_errors":{"type":["array","null"],"items":{}},"published_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]}},"required":["id","family_id","name","label","category","status","version","has_endpoint","first_screen","first_screen_dynamic","lint_errors_count","meta_flow_id","published_at","updated_at"],"title":"WhatsappFormResource"},"WhatsappFormRun":{"type":"object","properties":{"id":{"type":"integer"},"user_id":{"type":"integer"},"workspace_id":{"type":["integer","null"]},"flow_token":{"type":"string"},"whatsapp_form_id":{"type":"integer"},"contact_id":{"type":"integer"},"conversation_id":{"type":["integer","null"]},"automation_run_id":{"type":["integer","null"]},"node_id":{"type":["string","null"]},"origin":{"type":"string"},"channel":{"type":["string","null"]},"message_id":{"type":["string","null"]},"reply_message_id":{"type":["string","null"]},"status":{"type":"string"},"reason":{"type":["string","null"]},"context":{"type":["array","null"],"items":{}},"response_json":{"type":["array","null"],"items":{}},"partial_json":{"type":["array","null"],"items":{}},"last_screen_id":{"type":["string","null"]},"completed_after_expiry":{"type":"boolean"},"output_id":{"type":["string","null"]},"output_routed_at":{"type":["string","null"],"format":"date-time"},"sent_at":{"type":["string","null"],"format":"date-time"},"delivered_at":{"type":["string","null"],"format":"date-time"},"read_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":["string","null"],"format":"date-time"},"responded_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"environment":{"type":["string","null"]}},"required":["id","user_id","workspace_id","flow_token","whatsapp_form_id","contact_id","conversation_id","automation_run_id","node_id","origin","channel","message_id","reply_message_id","status","reason","context","response_json","partial_json","last_screen_id","completed_after_expiry","output_id","output_routed_at","sent_at","delivered_at","read_at","expires_at","responded_at","created_at","updated_at","environment"],"title":"WhatsappFormRun"},"WhatsappFormTemplate":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"definition":{"type":"array","items":{}},"sort":{"type":"integer"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","key","title","description","category","definition","sort","created_at","updated_at"],"title":"WhatsappFormTemplate"}},"responses":{"ValidationException":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]}}}},"AuthenticationException":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"AuthorizationException":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"ModelNotFoundException":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}},"webhooks":{"message.received":{"post":{"summary":"message.received","description":"Un contacto le escribió a un número de WhatsApp de la cuenta.\n\n`device_id` es el número de tu cuenta que recibió el mensaje: el mismo `device_id` que mandas para responder por ese número. Es `null` si el mensaje no tiene número asociado.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"message":{"type":"object","properties":{"type":{"type":"string","enum":["text","image","video","document","sticker","contact","audio","note","action","invalid","interactive","location","voice_call","video_call","event","button","template","notification","option_list","template_button_reply","poll","whatsapp_form","call_permission_request","call_permission_reply","request_contact_info"]}}}}}}},"example":{"id":"evt_000000000000000000000001","type":"message.received","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"message":{"id":1001,"type":"text","text":"Hola, quiero más información","media":null},"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"},"receiver":{"phone":"+5491100000001"},"device_id":4521}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"flow.completed":{"post":{"summary":"flow.completed","description":"Un contacto terminó un flujo de automatización.\n\nSe envía una sola vez por cada ejecución de un flujo, cuando termina con éxito. No se envía si la ejecución se cortó, se canceló, quedó bloqueada o falló. `contact` es `null` si la ejecución no tiene un contacto asociado. Un flujo muy usado puede generar muchos eventos seguidos.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000003","type":"flow.completed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"flow":{"id":3001,"name":"Flujo de ejemplo"},"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"}}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"broadcast.finished":{"post":{"summary":"broadcast.finished","description":"Una campaña llegó a su estado final (enviada, fallida o con fallos parciales), con sus conteos.\n\n`status` es `success`, `failed` o `partially_failed`. `reason` dice por qué terminó: `completed` (se enviaron todas las páginas), `cancelled` (se cerró una campaña pausada), `template_rejected` (Meta rechazó la plantilla, o su categoría cambió, mientras la campaña esperaba), `approval_expired` (la plantilla no se aprobó a tiempo), `mac_lockout` (la cuenta alcanzó su límite de contactos activos), `no_recipients` (la audiencia quedó vacía) o `error` (el envío no pudo despacharse). `totals` son los conteos del envío: `processed` (destinatarios procesados), `failed` y `skipped_unreachable` (destinatarios que el canal no puede alcanzar); valen 0 si la campaña terminó antes de enviar. Se emite una sola vez por campaña.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000011","type":"broadcast.finished","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"broadcast":{"id":6001,"name":"Campaña de ejemplo"},"status":"partially_failed","reason":"completed","totals":{"processed":1200,"failed":30,"skipped_unreachable":12}}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"contact.stage_changed":{"post":{"summary":"contact.stage_changed","description":"Un contacto cambió de etapa en un tablero.\n\nSe envía un evento por cada contacto que cambia de etapa en un tablero por etapas. `kind` es entry (entra al tablero, `from_stage` es null), move (pasa de una etapa a otra), exit (sale del tablero, `to_stage` es null) o stage_deleted (se reubica porque su etapa se borró; el nombre de la etapa borrada es null). No se envía si el contacto se coloca en la etapa en la que ya estaba.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000008","type":"contact.stage_changed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"},"board":{"id":5001,"name":"Embudo de ejemplo"},"kind":"move","from_stage":{"id":6001,"name":"Nuevo","position":0},"to_stage":{"id":6002,"name":"En seguimiento","position":1}}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"message.status_changed":{"post":{"summary":"message.status_changed","description":"$12a","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000014","type":"message.status_changed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"message_id":1001,"contact_id":2001,"device_id":4521,"status":"failed","previous_status":"sent","error":{"code":131047,"title":"Re-engagement message","reason":null},"occurred_at":"2026-10-01T12:00:00Z","client_reference":"pedido-1001"}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"conversation.closed":{"post":{"summary":"conversation.closed","description":"Una conversación pasó a cerrada.\n\nSe envía cuando una conversación pasa de abierta a cerrada. No se envía si la conversación ya estaba cerrada ni cuando se reabre.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000004","type":"conversation.closed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"}}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"conversation.assigned":{"post":{"summary":"conversation.assigned","description":"Una conversación quedó asignada a una persona del equipo o a un agente de IA.\n\nSe envía cuando una conversación queda asignada a una persona del equipo (`assignee.type` = `human`) o a un agente de IA (`assignee.type` = `ai`), por cualquier camino. `assignee` trae el tipo y el nombre, nunca un identificador. No se envía al desasignar, ni cuando se vuelve a enviar el mismo asignado.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000005","type":"conversation.assigned","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"},"assignee":{"type":"human","name":"Agente de ejemplo"}}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"contact.tag_added":{"post":{"summary":"contact.tag_added","description":"Un contacto recibió una etiqueta.\n\nSe envía un evento por cada contacto y etiqueta agregados, también en operaciones en bloque; no se envía si el contacto ya tenía la etiqueta. `source` indica el origen: manual, flow, bulk, import, sync, walink o ai. En operaciones en bloque grandes el límite de volumen de la cuenta puede descartar parte de los eventos.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000006","type":"contact.tag_added","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"},"tag":{"id":4001,"name":"Etiqueta de ejemplo"},"source":"manual"}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"broadcast.paused":{"post":{"summary":"broadcast.paused","description":"Una campaña se pausó sola, por ejemplo porque bajó la calidad del número.\n\n`reason` es `quality_degraded` (la calidad del número bajó respecto de la del inicio, o llegó a RED) o `quality_unreadable` (no se pudo leer la calidad en tres controles seguidos). `quality` y `quality_baseline` son la calidad de Meta leída en el control y la del inicio del envío (`GREEN`, `YELLOW`, `RED`), o `null` si no se pudo leer. Sólo las campañas con envío inteligente se pausan solas. Reanudar la campaña y que se pause otra vez emite otro evento.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000007","type":"broadcast.paused","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"broadcast":{"id":6001,"name":"Campaña de ejemplo"},"reason":"quality_degraded","quality":"YELLOW","quality_baseline":"GREEN"}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"contact.tag_removed":{"post":{"summary":"contact.tag_removed","description":"Un contacto perdió una etiqueta.\n\nSe envía un evento por cada contacto y etiqueta quitados, también en operaciones en bloque; no se envía si el contacto no tenía la etiqueta. No se envía al borrar la etiqueta, al borrar o fusionar contactos ni al desvincular etiquetas de un tablero. `source` indica el origen: manual, flow, bulk o ai. En operaciones en bloque grandes el límite de volumen de la cuenta puede descartar parte de los eventos.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000009","type":"contact.tag_removed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"},"tag":{"id":4001,"name":"Etiqueta de ejemplo"},"source":"manual"}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"contact.created":{"post":{"summary":"contact.created","description":"Se creó un contacto nuevo en la cuenta.\n\nSe envía un evento por cada contacto nuevo, sea cual sea el canal: un mensaje entrante, la creación manual, una importación o la API. No se envía cuando el contacto ya existía y sólo se actualiza, ni para los contactos que la plataforma crea para sus propias notificaciones. En importaciones grandes el límite de volumen de la cuenta puede descartar parte de los eventos.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000010","type":"contact.created","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000","email":"contacto@example.com"}}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"template.status_changed":{"post":{"summary":"template.status_changed","description":"Una plantilla cambió de estado de aprobación en Meta.\n\n`template` identifica la plantilla igual que `GET /templates` (`id`, `uid`, `name`, `category`). `previous_status` y `status` son los estados tal como los devuelve la API (por ejemplo `PENDING`, `APPROVED`, `REJECTED`, `PAUSED`); `previous_status` es `null` si la plantilla no tenía estado. `reason` trae la observación de rechazo (traducida como en la API y limitada a 500 caracteres) cuando el cambio es un rechazo informado al crear la plantilla, y es `null` en el resto. No se emite si Meta reenvía el estado que la plantilla ya tenía. Si una misma plantilla de Meta figura en varias cuentas, cada cuenta recibe su propio evento.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000012","type":"template.status_changed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"template":{"id":7001,"uid":"1234567890","name":"plantilla_ejemplo","category":"MARKETING"},"previous_status":"PENDING","status":"APPROVED","reason":null}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"flow.failed":{"post":{"summary":"flow.failed","description":"La ejecución de un flujo para un contacto terminó por un error.\n\nSe envía una sola vez por cada ejecución de un flujo que termina por un error, no porque llegó al final. `reason` indica el motivo y toma uno de estos valores: `node_missing` (el paso a ejecutar ya no existe), `unknown_node_type` (el paso es de un tipo no reconocido), `missing_subflow` (el flujo que debía ejecutarse dentro de otro ya no existe), `malformed_node` (el paso tiene una configuración dañada), `loop_detected` (la ejecución dio vueltas sin esperar nada) y `execution_error` (un error inesperado detuvo la ejecución). No se envía si la ejecución se canceló, quedó bloqueada o se cortó porque se editó el flujo o se unieron contactos. `contact` es `null` si la ejecución no tiene un contacto asociado.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000013","type":"flow.failed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"flow":{"id":3001,"name":"Flujo de ejemplo"},"contact":{"id":2001,"name":"Contacto de ejemplo","phone":"+5491100000000"},"reason":"execution_error"}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"whatsapp_form.completed":{"post":{"summary":"whatsapp_form.completed","description":"$12b","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000015","type":"whatsapp_form.completed","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"form":{"id":4001,"name":"Captar un lead","version_id":4002},"message_id":1001,"contact_id":2001,"device_id":5001,"answers":[{"key":"nombre","label":"Nombre","value":"Contacto de ejemplo"},{"key":"intereses","label":"Intereses","value":["op_a","op_b"]},{"key":"comentarios","label":"Comentarios","value":null}],"occurred_at":"2026-10-01T12:00:00Z"}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}},"webhook.test":{"post":{"summary":"webhook.test","description":"Evento de prueba enviado desde la ruta de prueba de una suscripción.","x-fc-status":"live","parameters":[{"name":"X-Funnelchat-Signature","in":"header","required":true,"description":"Firma de la entrega: `t=,v1=`. Se calcula sobre `t + \".\" + cuerpo crudo`.","schema":{"type":"string"}},{"name":"X-Funnelchat-Event","in":"header","required":true,"description":"Tipo de evento (igual que `type` en el cuerpo).","schema":{"type":"string"}},{"name":"X-Funnelchat-Delivery","in":"header","required":true,"description":"Identificador de esta entrega; cambia en cada intento.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"evt_000000000000000000000002","type":"webhook.test","version":1,"occurred_at":"2026-10-01T12:00:00Z","data":{"subscription":"00000000-0000-4000-8000-000000000001","sent_at":"2026-10-01T12:00:00Z"}}}}},"responses":{"2XX":{"description":"Cualquier respuesta 2xx en 10 segundos o menos confirma la entrega."}}}}},"tags":[{"name":"Contactos","kind":"nav"},{"name":"Contact","x-displayName":"Contactos","description":"Un contacto es la persona con la que tu negocio conversa por WhatsApp, identificada por `phone` o `whatsapp_id`. Su ficha reúne nombre, email, país, notas, campos personalizados, asesor asignado (`adviser_id`), el número que lo atiende (`device_id`) y su `lead_score`. Se relaciona con etiquetas, etapas de tableros, flujos y difusiones. Para sincronizar tu CRM sin duplicados, empezá por *Crear o actualizar un contacto*.","parent":"Contactos"},{"name":"ContactNote","x-displayName":"Notas de contactos","description":"Las notas son comentarios que el equipo deja en la ficha de un contacto, con texto (`body`), autor (`author_name`) y fecha. Sirven para registrar desde tu sistema algo que pasó fuera del chat, como una llamada, una compra o un reclamo. Podés listarlas con búsqueda por texto, agregarlas y eliminarlas.","parent":"Contactos"},{"name":"ContactCard","x-displayName":"Tarjetas de contacto","description":"Una tarjeta de contacto le comparte a un contacto los datos de otra persona, por ejemplo de un vendedor o de soporte. Se envía desde uno de tus números (`device_id`) e indica en `contact_card_ids` qué tarjetas mandar. Requiere el permiso `conversations:send`; revisá la nota de disponibilidad de la operación.","parent":"Contactos"},{"name":"ContactAutomation","x-displayName":"Automatizaciones del contacto","description":"Reúne lo que define cómo participa un contacto de las automatizaciones de la cuenta. *Pausar un contacto* lo pone en pausa (`paused_at`), y después podés filtrar a los pausados en conversaciones y difusiones; *Listar los flujos de un contacto* muestra en qué flujos está y si alguno sigue corriendo (`running`). Para que no ejecute flujos, cambiá `can_execute_flows` con *Actualizar un contacto*.","parent":"Contactos"},{"name":"ContactLeadScore","x-displayName":"Lead score del contacto","description":"El lead score estima qué tan caliente está un contacto a partir de señales de interacción. Para un contacto trae `score`, `category` (`hot`, `warm`, `cold` o `insufficient_data`), `confidence`, si está descalificado y el historial de señales que lo explican (`events`), paginado por cursor. Las reglas del cálculo están en Configuración del lead score.","parent":"Contactos"},{"name":"Organización","kind":"nav"},{"name":"Tag","x-displayName":"Etiquetas","description":"Las etiquetas (`name`, `description`, `color`) marcan contactos para segmentarlos según los criterios de tu negocio, y cada una puede informar cuántos contactos la tienen (`contact_count`). Se usan como filtro en contactos, conversaciones y difusiones, y un tablero en modo `tags` se arma con etiquetas. Para exportar un segmento, usá *Listar los contactos con una etiqueta*.","parent":"Organización"},{"name":"CustomField","x-displayName":"Campos personalizados","description":"Un campo personalizado es un dato propio de tu negocio que guardás en los contactos, como plan, ciudad o fecha de compra. Acá definís el campo (`name`, `description`, `type`; el tipo no se cambia después); los valores se cargan con *Asignar un campo personalizado a contactos*. Un tablero puede usar campos como valor y ganancia (`value_custom_field_id`, `profit_custom_field_id`).","parent":"Organización"},{"name":"Conversaciones y mensajes","kind":"nav"},{"name":"Conversation","x-displayName":"Conversaciones","description":"Una conversación es el chat de WhatsApp entre tu negocio y un contacto: puede estar activa o no (`active_conversation`), asignada a un asesor, marcada como favorita o sin leer, y la atiende uno de tus números. Acá podés listarlas con filtros, contarlas, gestionarlas traer el historial de mensajes de un contacto y ver un mensaje por su id, por ejemplo el que te devolvió un envío. Para armar tu propia bandeja, empezá por *Listar conversaciones* con `updated_since`.","parent":"Conversaciones y mensajes"},{"name":"Message","x-displayName":"Mensajes","description":"Contiene el envío de un mensaje de texto o archivo indicando en el cuerpo el `contact_id` y el número desde el que sale (`device_id`). Para enviar desde la ruta del contacto o leer el historial de mensajes, mirá Conversaciones. Requiere el permiso `conversations:send`; revisá la nota de disponibilidad de la operación.","parent":"Conversaciones y mensajes"},{"name":"MessageReaction","x-displayName":"Reacciones","description":"Una reacción es un emoji que ponés sobre un mensaje de una conversación, por ejemplo para acusar recibo sin escribir una respuesta. Podés reaccionar (`emoji`) o quitar tu reacción; las reacciones de cada mensaje vienen en `reactions` al listar los mensajes de un contacto. Requiere el permiso `conversations:send`; revisá la nota de disponibilidad de cada operación.","parent":"Conversaciones y mensajes"},{"name":"ForwardMessage","x-displayName":"Reenvío de mensajes","description":"Permite reenviar un mensaje de una conversación a otros contactos, eligiendo en `targets` desde qué número (`device_id`) sale cada envío. La respuesta trae un resultado por destino (`status`, `reason`). Requiere el permiso `conversations:send`; revisá la nota de disponibilidad de la operación.","parent":"Conversaciones y mensajes"},{"name":"QuickReply","x-displayName":"Respuestas rápidas","description":"Las respuestas rápidas son mensajes guardados, de texto o con archivo, que el equipo usa para contestar lo frecuente sin escribirlo cada vez. Cada una tiene `name`, `message`, `file`, un `type`, una visibilidad (`visibility`) y los agentes que la tienen disponible (`agent_ids`). Los IDs de agentes salen de *Listar agentes*.","parent":"Conversaciones y mensajes"},{"name":"MessageTemplate","x-displayName":"Plantillas","description":"Una plantilla es un mensaje de WhatsApp que Meta aprueba antes de usarse, con encabezado, cuerpo con variables, pie y botones, asociado a un número (`device_id`) y su WABA. Tiene `category` (`UTILITY`, `MARKETING` o `AUTHENTICATION`), `language_code` y un `status` de aprobación, como `PENDING`, `APPROVED` o `REJECTED`. La usan las difusiones y la necesitás cuando la ventana de 24 horas del contacto está cerrada.","parent":"Conversaciones y mensajes"},{"name":"Difusiones","kind":"nav"},{"name":"Broadcast","x-displayName":"Difusiones","description":"Una difusión es un envío masivo de una plantilla (`template_id`) desde uno de tus números a una audiencia segmentada por etiquetas, países, etapa de un tablero o lead score. Desde la API la podés consultar, medir (estadísticas, costo y estado por destinatario), cancelar y ordenar en carpetas. Para dimensionar una audiencia, empezá por *Contar contactos para una difusión*.","parent":"Difusiones"},{"name":"Flujos","kind":"nav"},{"name":"Flow","x-displayName":"Flujos","description":"Un flujo es una automatización: un disparador (`trigger_type`, `trigger_values`, `trigger_device_ids`) inicia una cadena de nodos (`nodes`) que se ejecuta para un contacto. Cada ejecución queda en curso, completada, invalidada o cancelada, y la podés cancelar. Los flujos se ordenan en Carpetas de flujos. Para diagnosticar por qué un contacto recibió o no una automatización, usá *Listar los flujos en curso de un contacto*.","parent":"Flujos"},{"name":"Folder","x-displayName":"Carpetas de flujos","description":"Las carpetas organizan tus flujos de automatización en una jerarquía: cada una tiene `name`, una carpeta madre opcional (`parent_id`), subcarpetas (`children`) y la cantidad de flujos que contiene (`flows_count`). Usá sus IDs para filtrar *Listar flujos* por `folder_id`. Las carpetas de difusiones son otras y están en Difusiones.","parent":"Flujos"},{"name":"Tableros","kind":"nav"},{"name":"KanbanSetting","x-displayName":"Tableros","description":"Un tablero kanban modela un proceso, como tu embudo de ventas o de atención, y ubica a cada contacto en una de sus etapas. Se arma por etapas o por etiquetas (`mode`), define a los cuántos días un contacto queda estancado (`stagnant_days`) y puede usar campos personalizados como valor y ganancia. Empezá por *Listar tableros*: sus IDs los piden las etapas, las conversaciones y las difusiones.","parent":"Tableros"},{"name":"KanbanStage","x-displayName":"Etapas de tableros","description":"Las etapas son los pasos de un tablero (`name`, `position`, `contacts_count`), y en cada tablero un contacto tiene una etapa actual (`current_stage_id`). Acá creás, reordenás y eliminás etapas, y movés o sacás contactos, de a uno o en bloque. Para reflejar el avance de un lead cuando algo pasa en tu sistema, usá *Mover un contacto de etapa*.","parent":"Tableros"},{"name":"Lead scoring","kind":"nav"},{"name":"LeadScoreSettings","x-displayName":"Configuración del lead score","description":"Define cómo se calcula el lead score de la cuenta: los umbrales de caliente y tibio (`hot_threshold`, `warm_threshold`), las señales mínimas (`min_signals`), la histéresis, el decaimiento de puntos con los días (`decay_steps`) y las reglas. También incluye *Ajustar el lead score de un contacto*, para sumar o restar puntos a mano con un motivo.","parent":"Lead scoring"},{"name":"LeadScoreDistribution","x-displayName":"Distribución del lead score","description":"Muestra cómo se reparte tu base de contactos entre las categorías del lead score (`hot`, `warm`, `cold` e `insufficient_data`), con el total y los umbrales vigentes. Sirve para un tablero de calidad de leads; para cambiar los umbrales, mirá Configuración del lead score.","parent":"Lead scoring"},{"name":"LeadScoreEventIngest","x-displayName":"Eventos de lead score","description":"Recibe señales de interacción que alimentan el lead score (`signal`): entradas y salidas de grupos, reacciones y votos en grupos, y clics en links. Cada evento identifica al contacto por `contact_id` o `phone` y lleva `occurred_at` y un `external_id`. Se mandan hasta 100 por llamada y se procesan después: la respuesta es `202`.","parent":"Lead scoring"},{"name":"Ventas y soporte","kind":"nav"},{"name":"SalesDashboard","x-displayName":"Ventas","description":"Reúne las ventas que reportan tus plataformas de pagos: cada venta trae producto, monto (`amount_minor`) y moneda, plataforma, tipo de evento, comprador (con su `contact_id` si lo hay) y atribución. Además del listado, hay métricas, el embudo de conversaciones a leads calificados y compras, y totales por plataforma, siempre en ventanas de 7, 30 o 90 días.","parent":"Ventas y soporte"},{"name":"PaymentProduct","x-displayName":"Productos de pago","description":"Lista los productos de una plataforma de pagos (`{platform}`) con su ID externo (`external_product_id`) y nombre. Sirve para relacionarlos con las ventas que reporta Funnelchat y con los flujos, que guardan `payment_platform` y `payment_external_product_id`.","parent":"Ventas y soporte"},{"name":"Ticket","x-displayName":"Tickets","description":"Un ticket es un caso abierto sobre un contacto (`contact_id`), con título, descripción, fecha límite (`deadline`) y un usuario del equipo responsable (`user_id`). Se puede crear, editar, reasignar, cerrar y reabrir, y listar por estado o por usuario. Si tu sistema detecta un reclamo, empezá por *Crear un ticket*; los IDs de usuario salen de *Listar agentes*.","parent":"Ventas y soporte"},{"name":"Equipo","kind":"nav"},{"name":"User","x-displayName":"Agentes","description":"Los agentes son las personas del equipo que atienden en la cuenta, con `name`, `email` y su alcance como asesor (`advisor_scope`). Sus IDs son los que necesitás para asignar conversaciones o tickets y para filtrar por asesor. Empezá por *Listar agentes*.","parent":"Equipo"},{"name":"Consumo","kind":"nav"},{"name":"Mac","x-displayName":"Contactos activos (MAC)","description":"Un MAC es un contacto activo que cuenta para el límite de contactos activos de tu plan en el ciclo. Cuando lo alcanzás empiezan 24 horas de gracia en las que todo sigue funcionando; si terminan sin que sumes capacidad, tu cuenta entra en bloqueo. *Ver el consumo de MACs* devuelve si el control está activo (`enforcement_enabled`), el estado (`state`: `normal`, `grace`, `enforcing` o `cleared`) y cuántos contactos quedaron registrados como inactivos en el ciclo (`inactive_contacts_count`). Para saber si un contacto puntual es inactivo, cada contacto y cada conversación traen `is_mac_inactive`. En bloqueo, un envío a un contacto inactivo responde `429` con `mac_lockout_24h`, sin `Retry-After`: vuelve a funcionar cuando el contacto deja de ser inactivo. También podés ver qué contactos cuentan como MAC y el historial.","parent":"Consumo"},{"name":"Webhooks","kind":"nav"},{"name":"WebhookSubscription","x-displayName":"Suscripciones de webhooks","description":"Una suscripción le indica a Funnelchat a qué URL HTTPS enviar, con un `POST` firmado, los eventos de conversaciones que elegiste en `events`, por ejemplo `message.received`, `contact.stage_changed` o `broadcast.finished` (o `*` para todos). El `secret` de firma se muestra una sola vez, al crearla o rotarlo. Empezá por *Crear un webhook* y verificá cada entrega con la cabecera `X-Funnelchat-Signature`.","parent":"Webhooks"},{"name":"WebhookDelivery","x-displayName":"Entregas de webhooks","description":"Cada evento que se envía a una suscripción genera intentos de entrega, con `status`, código HTTP recibido (`http_status`), duración, error y fecha del próximo reintento (`next_attempt_at`). Una entrega es exitosa si tu servidor responde `2xx` en 10 segundos o menos; si no, se reintenta, hasta 4 intentos. Usá *Listar entregas de un webhook* para depurar tu receptor.","parent":"Webhooks"},{"name":"WebhookTest","x-displayName":"Prueba de webhooks","description":"Envía ya a la URL de una suscripción un evento `webhook.test`, firmado igual que uno real, y te devuelve el intento como una entrega más. Queda en el historial de entregas y no se reintenta. Usalo para probar tu receptor y tu verificación de firma antes de depender de él.","parent":"Webhooks"},{"name":"WebhookEventCatalog","x-displayName":"Catálogo de eventos","description":"Lista los tipos de evento de conversaciones a los que te podés suscribir, con su estado, si se pueden suscribir y un ejemplo del cuerpo que vas a recibir. Consultalo antes de *Crear un webhook* para elegir los valores de `events` y preparar tu receptor.","parent":"Webhooks"},{"name":"Otros","kind":"nav"},{"name":"ShowMessage","parent":"Otros"},{"name":"WhatsappForm","parent":"Otros"},{"name":"WhatsappFormSend","x-displayName":"Formularios de WhatsApp","description":"Un formulario de WhatsApp es un formulario de varias pantallas que el contacto completa dentro del chat. Acá se envía uno ya publicado a un contacto, con `form_id` (el identificador estable del formulario) y el número de WhatsApp Cloud por el que sale (`device_id`). Cuando el contacto lo completa llega el evento `whatsapp_form.completed`. Requiere el permiso `conversations:send`.","parent":"Otros"}],"x-tagGroups":[{"name":"Contactos","tags":["Contact","ContactNote","ContactCard","ContactAutomation","ContactLeadScore"]},{"name":"Organización","tags":["Tag","CustomField"]},{"name":"Conversaciones y mensajes","tags":["Conversation","Message","MessageReaction","ForwardMessage","QuickReply","MessageTemplate"]},{"name":"Difusiones","tags":["Broadcast"]},{"name":"Flujos","tags":["Flow","Folder"]},{"name":"Tableros","tags":["KanbanSetting","KanbanStage"]},{"name":"Lead scoring","tags":["LeadScoreSettings","LeadScoreDistribution","LeadScoreEventIngest"]},{"name":"Ventas y soporte","tags":["SalesDashboard","PaymentProduct","Ticket"]},{"name":"Equipo","tags":["User"]},{"name":"Consumo","tags":["Mac"]},{"name":"Webhooks","tags":["WebhookSubscription","WebhookDelivery","WebhookTest","WebhookEventCatalog"]},{"name":"Otros","tags":["ShowMessage","WhatsappForm","WhatsappFormSend"]}]}},"proxyUrl":"$undefined"}}]]}]]}]

conversation.closed

CabecerasCopiar el enlace a esta sección

Cuerpo del pedidoCopiar el enlace a esta sección

Cuerpo de la respuestaCopiar el enlace a esta sección

Cuerpo del pedidoapplication/json

Cabeceras

Cabeceras

Cuerpo del pedido

Cuerpo de la respuesta