Common Authentication Properties
All operations require these two properties:
| Property | Required | Description |
|---|
AccessToken | Required | Meta/WhatsApp Business API access token. Store in BizFirst Credentials Manager. |
PhoneNumberId | Required | The numeric phone number ID for your registered WhatsApp Business phone number. |
Resource: message
message/sendText
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format (e.g. +14155552671). No spaces or dashes. |
Text | Required | Message text. Supports BizFirst expressions. Max 4096 characters. |
PreviewUrl | Optional | Boolean. When true, WhatsApp will unfurl the first URL in the message as a link preview. |
message/sendImage
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
ImageUrl | Required* | Publicly accessible HTTPS URL of the image. Required if ImageBase64 is not provided. |
ImageBase64 | Required* | Base64-encoded image data. Required if ImageUrl is not provided. |
Caption | Optional | Caption text displayed below the image. |
message/sendVideo
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
VideoUrl | Required* | Publicly accessible HTTPS URL of the video. Required if VideoBase64 is not provided. |
VideoBase64 | Required* | Base64-encoded video data. Required if VideoUrl is not provided. |
Caption | Optional | Caption text displayed below the video. |
message/sendAudio
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
AudioUrl | Required* | HTTPS URL of the audio file. Required if AudioBase64 is not provided. |
AudioBase64 | Required* | Base64-encoded audio data. Required if AudioUrl is not provided. |
message/sendDocument
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
DocumentUrl | Required* | HTTPS URL of the document. Required if DocumentBase64 is not provided. |
DocumentBase64 | Required* | Base64-encoded document data. Required if DocumentUrl is not provided. |
Filename | Optional | Filename shown to the recipient (e.g. Invoice_2026.pdf). |
Caption | Optional | Caption text displayed with the document. |
message/sendSticker
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
StickerUrl | Required | HTTPS URL of a WebP sticker file. |
message/sendLocation
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
Latitude | Required | Decimal latitude (e.g. 51.5074). |
Longitude | Required | Decimal longitude (e.g. -0.1278). |
Name | Optional | Location name shown on the pin (e.g. "Head Office"). |
Address | Optional | Street address shown below the location name. |
message/sendContacts
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
Contacts | Required | JSON array of vCard-style contact objects. Each object can include name (with first_name/last_name), phones (array), and emails (array). |
message/sendInteractiveButtons
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
BodyText | Required | Main message body text displayed above the buttons. |
Buttons | Required | JSON array of up to 3 button objects. Each must have id (string, returned on tap) and title (displayed label, max 20 chars). |
Header | Optional | Optional header text displayed above the body. |
Footer | Optional | Optional footer text displayed below the buttons. |
message/sendInteractiveList
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
BodyText | Required | Main message body text. |
ButtonTitle | Required | Label on the button that opens the list (e.g. "View Options"). |
Sections | Required | JSON array of section objects. Each section has a title and a rows array. Each row has id, title, and optional description. |
message/sendReaction
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
MessageId | Required | The WhatsApp message ID to react to (wamid format). |
Emoji | Required | Unicode emoji character to send as the reaction (e.g. 👍). |
message/sendTemplate
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
TemplateName | Required | Exact name of the Meta-approved message template. |
LanguageCode | Required | Language code matching the template's approved language (e.g. en_US, es_MX). |
Components | Optional | JSON array of template component parameter objects (header, body, buttons). Maps positional variables to template placeholders. |
message/sendAndWait
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
Text | Required | Message text to send. The workflow suspends after sending and resumes when a reply is received. |
TimeoutSeconds | Optional | Maximum seconds to wait for a reply before the workflow resumes on the timeout port. |
message/markAsRead
| Property | Required | Description |
|---|
MessageId | Required | The WhatsApp message ID to mark as read (wamid format). |
message/sendTypingIndicator
| Property | Required | Description |
|---|
To | Required | Recipient phone number in E.164 format. |
Resource: media
media/upload
| Property | Required | Description |
|---|
FileData | Required | Base64-encoded file content to upload. |
MimeType | Required | MIME type of the file (e.g. image/jpeg, application/pdf). |
Filename | Optional | Filename to associate with the uploaded media. |
media/download
| Property | Required | Description |
|---|
MediaId | Required | The media ID returned by a previous upload or received in an incoming webhook. Returns base64 file data. |
media/delete
| Property | Required | Description |
|---|
MediaId | Required | The media ID of the file to delete from WhatsApp hosting. |
media/getInfo
| Property | Required | Description |
|---|
MediaId | Required | The media ID to retrieve info for. Returns mimeType, fileSize, url, sha256. |
Resource: template
template/create
| Property | Required | Description |
|---|
BusinessAccountId | Required | Your WhatsApp Business Account ID (WABA ID). |
Name | Required | Template name — lowercase, underscores only (e.g. order_shipped_v2). |
Category | Required | Template category: MARKETING, UTILITY, or AUTHENTICATION. |
Language | Required | Language code (e.g. en_US). |
Components | Required | JSON array of component objects defining the template structure (header, body, footer, buttons). |
template/list
| Property | Required | Description |
|---|
BusinessAccountId | Required | Your WhatsApp Business Account ID. |
Limit | Optional | Maximum number of templates to return per page (integer). |
After | Optional | Pagination cursor returned in a previous list response. |
template/get
| Property | Required | Description |
|---|
BusinessAccountId | Required | Your WhatsApp Business Account ID. |
TemplateId | Required | The template ID to retrieve. |
Resource: profile
profile/getContact
Returns name, phone, profilePictureUrl for the phone number associated with the PhoneNumberId credential.
profile/getBusinessProfile
Returns description, address, email, websites, vertical for the business profile registered to the PhoneNumberId.
Resource: group
group/create
| Property | Required | Description |
|---|
Subject | Required | Group name/subject. |
Participants | Required | JSON array of E.164 phone numbers to add as initial members. |
group/get, group/delete, group/getMembers, group/getInviteLink
| Property | Required | Description |
|---|
GroupId | Required | The WhatsApp group ID. |
group/addMember, group/removeMember, group/promoteAdmin, group/demoteAdmin
| Property | Required | Description |
|---|
GroupId | Required | The WhatsApp group ID. |
PhoneNumber | Required | E.164 phone number of the member to add, remove, promote, or demote. |
group/sendMessage
| Property | Required | Description |
|---|
GroupId | Required | The WhatsApp group ID to send the message to. |
Text | Required | Message text to send to the group. |
Phone number format: All To and PhoneNumber fields must be valid E.164 format — plus sign, country code, and number, with no spaces, dashes, or parentheses. Example: +14155552671. Messages to incorrectly formatted numbers will fail silently at the Meta API.
