Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Transactional WhatsApp

Send a WhatsApp message

This endpoint is used to send a WhatsApp message. <br/>(The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.)

post/whatsapp/sendMessage

Request body

templateIdinteger

ID of the template to send

textstring

Text to be sent as message body (will be overridden if templateId is passed in the same request)

senderNumberstring mobile required

WhatsApp Number with country code. Example, 85264318721

paramsobject

Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}.

contactNumbersstring[] required

List of phone numbers of the contacts

Example request

{
  "templateId": 123,
  "text": "Hi! There i am a message",
  "senderNumber": "919876543210",
  "params": {
    "FNAME": "Joe",
    "LNAME": "Doe"
  },
  "contactNumbers": [
    "919876543210"
  ]
}

Response

successfully created

messageIdstring uuidv4 required

messageId of sent message

Example response

{
  "messageId": "23befbae-1505-47a8-bd27-e30ef739f32c"
}