Send WhatsApp message

Sends a single templated message to a single recipient. Templates need to be registered and pre-approved by WhatsApp.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Registered WhatsApp sender number.

  • Must be in international format following the E.164 standard (e.g., +14155238886).
  • Number must be registered with the WhatsApp Business API.
string
required

Recipient phone number in international format.

  • Must follow E.164 format (e.g., +14155238886 for a US number).
  • No spaces, dashes, or special characters.
  • The recipient must have an active WhatsApp account.
  • Ensure the recipient has opted in to receive WhatsApp messages.
string
enum
required

Type of the message content.

Allowed:
content
required

The message content to be sent.

  • Must follow the WhastApp-approved template format or be a custom object following the Meta Cloud API guidelines.
  • Example JSON (Text Content):
    {
      "text": {
        "message": "hello, world!",
      }
    }
  • Example JSON (Template Content):
    {
      "template": {
        "name": "order_update",
        "parameters": ["123456"]
      }
    }
  • Example JSON (Custom Content):
    {
      "custom": {
        "type": "template",
        "template": {
          "name": "template_img_simple_1",
          "language": {
            "code": "en",
            "policy": "deterministic"
          },
          "components": [
            {
              "type": "HEADER",
              "parameters": [
                {
                  "type": "image",
                  "image": {
                    "link": "https://image-test.jpg"
                  }
                }
              ]
            }
          ]
        }
      }
    }
sms_fallback
object

SMS fallback message details.

string

A unique reference ID supplied by your system to track messages.

  • Maximum Length: 500 characters.
  • This message_ref will be included in webhook events, allowing you to correlate sent messages with received events.

Example Usage:

  • Sending a message with message_ref: "order-12345"
  • Receiving a delivery webhook containing message_ref: "order-12345", confirming it was delivered.
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json