Skip to main content
POST
Enviar plantilla en masa

Autorizaciones

Authorization
string
header
requerido

Token JWT de autenticação

Encabezados

x-company-id
string

Identificador de la empresa objetivo. Obligatorio solo para API keys globales (type=global). Se ignora para API keys de empresa y usuarios humanos.

Cuerpo

multipart/form-data
inboxId
string
requerido

ID del inbox/conexión de WhatsApp que se usará para enviar

Minimum string length: 1
templateName
string
requerido

Nombre de la plantilla registrada en WhatsApp Business

Minimum string length: 1
languageCode
string
predeterminado:pt_BR

Código de idioma de la plantilla (formato: pt_BR, en_US, en, etc.)

components
object[]

Lista de componentes de la plantilla con sus parámetros/variables. Úsela para personalizar header, body y buttons con datos dinámicos.

contacts
object[]

Lista de contactos que recibirán la plantilla. Opcional si envía un archivo CSV/Excel con los contactos.

who_will_answer
enum<string>
predeterminado:AGENT

Define quién responderá después del envío de la plantilla. Valores: AGENT (agente de IA), HUMAN (agente humano). Predeterminado: AGENT

Opciones disponibles:
AGENT,
HUMAN,
UNASSIGNED
agentToActivate
string

ID del agente de IA que se activará para responder. Se usa junto con who_will_answer=AGENT

keep_existing_assignment
boolean
predeterminado:false

Si es true, preserva la asignación actual de la conversación: no se escribe nada en propietario/agente y el who_will_answer NO se aplica (la IA no asume). Default false para no alterar el comportamiento de integraciones existentes por API key — el front de atención envía true.

owner_user_id
string | null

ID del usuario propietario de la conversación. null es la elección explícita de "No asignado" (autoriza a borrar el propietario actual); su ausencia significa que el caller no opinó sobre la asignación.

attendant_user_id
string | null

ID del usuario agente humano. Aplica cuando who_will_answer=HUMAN. null es "No asignado" explícito; su ausencia significa que el caller no opinó. El propietario tiene precedencia: conversation.user = owner ?? attendant.

Respuesta

Envío en masa ejecutado correctamente (devuelve estadísticas detalladas)

totalProcessed
number
requerido

Total de contactos procesados

sentCount
number
requerido

Cantidad de mensajes enviados correctamente

errorCount
number
requerido

Cantidad de errores durante el envío

errors
object[]
requerido

Lista detallada de errores ocurridos

sentContacts
object[]
requerido

Lista de contactos que recibieron el mensaje correctamente