Skip to main content
POST
Enviar un template (campaña)

Authorizations

X-API-Key
string
header
required

API key provista por Xenda (formato xnd_...). Se envía en todas las llamadas.

Body

application/json
idempotency_key
string
required

Clave única por envío. Reintentos con la misma clave no duplican el envío.

Maximum string length: 128
recipients
object[]
required
Required array length: 1 - 1000 elements
template_name
string

Nombre exacto del template aprobado. Requerido si no mandás template_id.

template_language
string

Código de idioma (ej. es_AR). Requerido solo si el template existe en más de un idioma.

template_id
string

ID del template (alternativa a template_name).

external_ref
string

Tu referencia (ej. ID de presupuesto). Se devuelve en la respuesta y en el webhook de respuestas.

campaign_name
string

Nombre visible de la campaña en la plataforma. Default: API - {template} - {external_ref}.

header_media_url
string

URL pública https del archivo del header. Obligatorio si el template tiene header de imagen, video o documento (PDF) — sin este campo el envío devuelve 400. No se acepta base64: el archivo tiene que estar hosteado y ser descargable sin autenticación. Límites de WhatsApp: imagen 5 MB (jpg/png), video 16 MB (mp4), documento 100 MB (PDF). Para documentos, el nombre del archivo se toma de la URL.

Response

Envío ejecutado (o replay idempotente de un envío previo).

campaign_id
string

ID del envío. Guardalo — viene en el webhook de respuestas.

status
enum<string>
Available options:
sent
campaign_name
string
external_ref
string | null
recipients
object
replayed
boolean

true si esta respuesta es el replay de un envío previo con la misma idempotency_key.