Send WhatsApp message

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á!"
  }
}
'

{
  "success": true,
  "data": {
    "messageIds": [
      "clxx1...",
      "clxx2..."
    ],
    "status": "QUEUED",
    "scheduledAt": null
  }
}

{
  "success": false,
  "error": "Bad Request",
  "message": "Validation failed",
  "details": [
    {
      "field": "payload.message",
      "message": "text type requires payload.message"
    }
  ],
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "Too Many Requests",
  "code": "WARMUP_DAILY_LIMIT",
  "message": "This instance is in the warm-up period (first 3 days). Daily send limit is 20. Try again tomorrow or wait until warm-up ends."
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

POST

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á!"
  }
}
'

{
  "success": true,
  "data": {
    "messageIds": [
      "clxx1...",
      "clxx2..."
    ],
    "status": "QUEUED",
    "scheduledAt": null
  }
}

{
  "success": false,
  "error": "Bad Request",
  "message": "Validation failed",
  "details": [
    {
      "field": "payload.message",
      "message": "text type requires payload.message"
    }
  ],
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "Too Many Requests",
  "code": "WARMUP_DAILY_LIMIT",
  "message": "This instance is in the warm-up period (first 3 days). Daily send limit is 20. Try again tomorrow or wait until warm-up ends."
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

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 instance WhatsApp do workspace.

string[]

required

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

Required array length: 1 - 100 elements

type

enum<string>

required

Message type. Official Meta templates: use POST /v1/templates/send (no type: template here).

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 (requireds); caption optional. location: latitude, longitude, name, address. contact: contact ou contactId. buttons: title, description, buttons (1 a 3); footer optional. list: title, description, buttonText, listSections; footer optional.

Show child attributes

schedule

object

Show child attributes

options

object

Show child attributes

metadata

object

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

Show child attributes

Response

Message(ns) aceita(s). Enfileirada(s) ou agendada(s). Response 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.

Show child attributes

List WhatsApp messages Get inbound WhatsApp