Send message

Transactional WhatsApp

curl --request POST \
  --url https://webhook.cocoonmail.com/webhook/whatsapp_message/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_number": "+910000000000",
  "type": "text",
  "content": {
    "body": "Hello"
  },
  "recipient": [
    {
      "whatsapp_number": "<string>",
      "first_name": "<string>",
      "email": "<string>",
      "attributes": {}
    }
  ]
}
'

{
    "success": true,
    "message": "WhatsApp message(s) sent successfully."
}

POST

webhook

whatsapp_message

send

Transactional WhatsApp

curl --request POST \
  --url https://webhook.cocoonmail.com/webhook/whatsapp_message/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_number": "+910000000000",
  "type": "text",
  "content": {
    "body": "Hello"
  },
  "recipient": [
    {
      "whatsapp_number": "<string>",
      "first_name": "<string>",
      "email": "<string>",
      "attributes": {}
    }
  ]
}
'

{
    "success": true,
    "message": "WhatsApp message(s) sent successfully."
}

Send WhatsApp messages to one or more recipients using pre-approved templates. This endpoint supports personalization through overwrite_variables and event data.

Request Body

The request body must include the sender’s phone number, template details, and recipient information.

overwrite_variables: An object containing key-value pairs used to replace dynamic variables or merge tags within the chosen WhatsApp template.
event: (Optional) Event-related data for tracking or triggering specific workflows.

Example Payloads

Text Message
Template Message
Template media
Media

Send a simple text message to recipients.

{
    "from_number": "<string>",
    "type": "text",
    "content": {
        "body": "<string>"
    },
    "recipient": [
        {
            "whatsapp_number": "<string>",
            "first_name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "plan": "<string>"
            }
        },
        {
            "whatsapp_number": "<string>",
            "name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "area": "<string>"
            }
        }
    ]
}

Send a message using a pre-approved WhatsApp template with custom parameters and event data.

{
    "from_number": "<string>",
    "type": "template",
    "content": {
        "template_name": "<string>",
        "template_language": "<string>"
    },
    "recipient": [
        {
            "whatsapp_number": "<string>",
            "first_name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "plan": "<string>"
            }
        },
        {
            "whatsapp_number": "<string>",
            "name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "area": "<string>"
            }
        }
    ],
    "overwrite_variables": {
        "organization.company_name": "<string>",
        "organization.business_type": "<string>",
        "organization_address.street": "<string>",
        "organization_social.instagram": "<string>"
    },
    "event": {
        "code": "START",
        "name": "start",
        "data": {
            "date_time": "2026-01-27T01:30:21.311Z",
            "event_name": "24hr marathon run",
            "bib_number": "101",
            "start_time": "2026-01-15T01:30:03.588Z"
        }
    }
}

Send an image file with an optional caption using pre-approved template media.

{
    "from_number": "<string>",
    "type": "template",
    "content": {
        "template_name": "<string>",
        "template_language": "<string>"
    },
    "parameterized_media": {
        "type": "document",
        "link": "https://pix8.agoda.net/hotelImages/{{contact.image_path}}"
    },
    "recipient": [
        {
            "whatsapp_number": "<string>",
            "first_name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "plan": "<string>"
            }
        },
        {
            "whatsapp_number": "<string>",
            "name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "area": "<string>"
            }
        }
    ]
}

Send a media file (document, video, or image) with an optional caption.

{
    "from_number": "<string>",
    "type": "document",
    "content": {
        "media_url": "https://example.com/media.file",
        "caption": "<string>"
    },
    "recipient": [
        {
            "whatsapp_number": "<string>",
            "first_name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "plan": "<string>"
            }
        },
        {
            "whatsapp_number": "<string>",
            "name": "<string>",
            "email": "<string>",
            "attributes": {
                "city": "<string>",
                "area": "<string>"
            }
        }
    ]
}

Note: The type field can be set to document, video, or image depending on the media being sent.

{
    "success": true,
    "message": "WhatsApp message(s) sent successfully."
}

Authorizations

Authorization

string

header

required

Use your API key with the 'Bearer ' prefix

Body

application/json

Text Message
Template Message
Template media
Media

Send a simple text message

from_number

string

required

Example:

"+910000000000"

type

enum<string>

default:text

required

Available options:

text

Example:

"text"

content

object

required

Show child attributes

recipient

object[]

required

Show child attributes

Response

WhatsApp message(s) sent successfully.

Mail status Send OTP

Get started

Contacts

Workflow builder

Events

Transactional email

Whatsapp

API

Integrations

Deliverability

SDKs

Account

Request Body

Example Payloads

Authorizations

Body

Response

Get started

Contacts

Workflow builder

Events

Transactional email

Whatsapp

API

Integrations

Deliverability

SDKs

Account

​Request Body

​Example Payloads

Authorizations

Body

Response

Request Body

Example Payloads