Skip to main content
POST
Send a WhatsApp message

Authorizations

Authorization
string
header
required

HTTP Basic where username is your account e-mail and password is your security token.

Body

sender_name
string
required
sender_document
string
required

Sender CPF/CNPJ.

recipient_name
string
required
recipient_phone
string
required

Normalized to E.164.

recipient_document
string
required
template_id
integer
required

Must be an approved template belonging to the selected sender. With system senders, the template must have been created by you (or your team owner) or be shared.

paymentMethod
enum<string>
required
Available options:
escrybe_credits,
invoice,
team
team_member_id
integer

Required when paymentMethod=team.

body
string
Maximum string length: 4096
template_variables
object

Map of template variable substitutions. Must cover at least the template's variable count.

media_url
string

One of media_url/media_file/media_base64 is required when the template header format is IMAGE or DOCUMENT.

media_filename
string
media_file
file

IMAGE JPEG/PNG ≤5MB; DOCUMENT PDF ≤100MB. Password-protected PDFs are rejected.

media_base64
string
sender_choice
string
default:system

system or explicit sender.

sender_id
integer

Specific sender to use.

Response

Message created and awaiting payment

Standard envelope used by the WhatsApp message and sender endpoints (same shape as the letters and e-mail envelopes).

status
integer
Example:

200

status_message
string
data
object