Skip to main content
POST
Send a message

Authorizations

x-api-key
string
header
required

Your Pilot Status API key (ps_...). You may also send Authorization: Bearer ps_... or ?access_token=ps_....

Path Parameters

phoneNumberId
string
required

Meta phone-number id of the number linked to your API key.

Body

application/json
messaging_product
enum<string>
required

Always whatsapp.

Available options:
whatsapp
Example:

"whatsapp"

to
string
required

Recipient MSISDN (or group id).

Example:

"5511999999999"

type
enum<string>
required

Message kind — selects which object below to fill.

Available options:
text,
image,
audio,
video,
document,
sticker,
location,
contacts,
interactive,
template,
reaction
Example:

"text"

recipient_type
enum<string>

individual or group.

Available options:
individual,
group
Example:

"individual"

text
object
Example:
image
object
audio
object
video
object
document
object
sticker
object
location
object
contacts
object[]

Contact cards.

interactive
object

Interactive message (buttons/list/CTA/flow).

template
object
reaction
object
context
object

Quote/reply context.

Response

Meta Graph API response.

messaging_product
string
contacts
object[]
messages
object[]