Skip to main content
POST
/
v1
/
whatsapp
/
messages
curl --request POST \
  --url https://api.notifique.dev/v1/whatsapp/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "clxx...",
  "to": [
    "5511999999999"
  ],
  "type": "text",
  "payload": {
    "message": "Olá!"
  },
  "options": {
    "priority": "normal"
  }
}
'
{
  "success": true,
  "data": {
    "messageIds": [
      "clxx1...",
      "clxx2..."
    ],
    "status": "QUEUED",
    "scheduledAt": null
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

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

​
x-idempotency-key
string

Body

application/json
​
instanceId
string
required

ID da instância WhatsApp do workspace.

​
to
string[]
required

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

Required array length: 1 - 100 elements
​
type
enum<string>
required

Tipo da mensagem. buttons: até 3 botões (reply, url ou call — um tipo por mensagem). list: lista interativa com buttonText, listSections e no máximo 10 linhas no total.

Available options:
text,
image,
video,
audio,
document,
location,
contact,
buttons,
list
​
payload
object
required

Conteúdo conforme type. text: message. image|video|audio|document: mediaUrl, fileName, mimetype (obrigatórios); caption opcional. location: latitude, longitude, name, address. contact: contact ou contactId. buttons: title, description, buttons (1 a 3); footer opcional. list: title, description, buttonText, listSections; footer opcional.

​
schedule
object
​
options
object

Response

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

​
success
boolean
Example:

true

​
data
object

Conteúdo de data na resposta de envio.