Skip to main content
POST

Autorizaciones

Authorization
string
header
requerido

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Encabezados

Idempotency-Key
string

Chave única para idempotência. Alternativa: x-idempotency-key.

x-idempotency-key
string

Cuerpo

application/json
to
string[]
requerido

Destinatários: números com DDI (ex.: 5511999999999) ou JID de grupo (ex.: 120363295648424210@g.us). Uma mensaje por item.

Required array length: 1 - 500 elements
type
enum<string>
requerido

Tipo de mensaje. Use template con payload.templateId para plantillas del workspace (oficial o no oficial).

Opciones disponibles:
text,
image,
video,
audio,
document,
location,
contact,
buttons,
list,
carousel,
template
payload
object
requerido

Contenido según type. text: message. image|video|audio|document: mediaUrl, fileName, mimetype (obligatorios); caption opcional. location: latitude, longitude, name, address. contact: contact o contactId. buttons: title, description, buttons (1 a 3; reply | copy | url | call | pix). list: title, description, buttonText, listSections. carousel: cards (1 a 10). template: templateId, variables, headerMediaUrl, carouselCardMediaUrls.

from
string
requerido

Remetente WhatsApp: id da instância, id ou nome do pool, telefone E.164 ou nome da instância.

schedule
object
options
object
metadata
object

Metadados por envio, mesclados em Message.metadata (pares string→string). Respeite limites de payload.

localization
object

Tradução por destinatário (manual ou IA). Campos traduzíveis: payload.message, payload.caption.

i18n
object

Mapa locale → string ou objeto com chaves por campo (message, caption, …). Usado com localization.mode=manual.

variables
object

Variáveis para substituir placeholders {{chave}} em payload.message, payload.caption e options.autoReplyText.

Respuesta

Mensaje(ns) aceita(s). Enfileirada(s) ou agendada(s). Respuesta padronizada com envelope success/data; status em MAIÚSCULO (QUEUED, SCHEDULED).

success
boolean
Ejemplo:

true

data
object

Conteúdo de data na resposta de envio.

Ejemplo: