Skip to main content
POST
/
v1
/
messages
/
send
Send message
curl --request POST \
  --url https://pilotstatus.com.br/v1/messages/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "templateId": "boas_vindas",
  "destinationNumber": "5511988887777",
  "variables": {
    "nome": "Ana"
  }
}
'
{
  "id": "msg_01HZX...",
  "correlationId": "corr_01HZX...",
  "status": "QUEUED",
  "createdAt": "2026-06-20T10:00:00.000Z",
  "origin": "Suporte",
  "sourceNumber": "5511999999999"
}

Authorizations

​
x-api-key
string
header
required

Your ps_ API key

Body

application/json
​
templateId
string

Template id or name (mutually exclusive with text).

Example:

"boas_vindas"

​
text
string

Free-form text (mutually exclusive with templateId).

Example:

"Olá! Sua entrega chegou."

​
destinationNumber
string

Destination (exactly one). Accepts an E.164 phone OR a BSUID — the contact's durable userId (e.g. BR.13491208655302741918), returned by GET /api/v1/conversations. Use the BSUID to reply to contacts using a WhatsApp username (no phone). One-tap/zero-tap/copy-code authentication templates require a phone number.

Example:

"5511988887777"

​
groupId
string

Group JID. NOT_SUPPORTED_FOR_META.

Example:

"123456789-987654321@g.us"

​
newsletterId
string

Channel/newsletter JID. NOT_SUPPORTED_FOR_META.

Example:

"120363000000000000@newsletter"

​
variables
string

Template variables (default {}).

Example:

"{ \"nome\": \"Ana\" }"

​
media
string

Public http(s) URL OR base64 data URI (e.g. data:audio/ogg;base64,AAAA…). Base64 works on Meta Cloud API and Evolution v2; on Evolution GO use a public http(s) URL (GO does not accept base64). Used in template mode or in direct-media mode (media + mediaType, without templateId and without text).

Example:

"https://cdn.acme.com/img.png"

​
mediaType
string

Media type. In direct-media mode (no templateId/text) send media + mediaType: optional caption for image/video/document (not for audio); buttons/header/footer/variables not allowed. "audio" is delivered as a voice note (PTT) on Meta Cloud API, Evolution v2, and Evolution GO; on Evolution v2 and GO a "recording audio" presence indicator is shown to the recipient before the voice note (Meta has no outbound presence API).

Example:

"image"

​
buttons
string

Buttons (QUICK_REPLY/URL/PHONE_NUMBER/COPY_CODE).

​
header
string

Header for free-form (with buttons).

​
footer
string

Footer for free-form (with buttons).

​
deliverAt
string

Schedule delivery for a future time.

Example:

"2026-06-21T09:00:00Z"

​
deliverUntil
string

Maximum delivery window.

Example:

"2026-06-21T18:00:00Z"

​
labels
string

Labels to apply to the destination conversation.

Example:

"[\"pedido\", \"vip\"]"

Response

Send template