Skip to main content
POST
Message a customer first

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

external_ref
string
required

Your own id for the customer business, set when you created it.

Body

application/json
to
string
required

The customer phone number, or the Messenger or Instagram customer id.

channel
enum<string>

Default whatsapp.

Available options:
whatsapp,
messenger,
instagram
whatsapp_number
string

The phone_number_id to send from. Default is the first connected number.

type
string

One of text, template, image, video, audio, document, interactive, location, reaction. Default text.

text
string

The message text. Required for text.

reply_to
string

A message id or provider message id to quote.

template_name
string

The approved template to send. Required for template.

lang
string

The template language. Default en_US.

body_params
string[]

The values for the template body.

components
object[]

Template components, as Meta defines them.

A public link to the file, for a media type.

media_id
string

A provider media id, for a media type. Send link or media_id.

caption
string

A caption for a media type. 1024 characters at most.

filename
string

A file name for a document.

payload
object

For interactive, location and reaction.

tag
string

Messenger only: HUMAN_AGENT.

Response

Success