WhatsApp Campaigns

Create and Send a WhatsApp campaign

post/whatsappCampaigns

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/whatsappCampaigns
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Request body

namestring required

Name of the WhatsApp campaign creation

templateIdinteger required

Id of the WhatsApp template in approved state

scheduledAtstring required

Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: 2017-06-01T12:30:00+02:00

Example request

{
  "name": "Test Campaign",
  "templateId": 19,
  "scheduledAt": "2017-06-01T10:30:00.000+0000",
  "recipients": {
    "excludedListIds": [
      8
    ],
    "listIds": [
      32
    ],
    "segments": [
      23
    ]
  }
}

Response

WhatsApp campaign created

idinteger required

ID of the object created

Example response

{
  "id": 122
}

Changes

No recorded changes to this operation across all 2 revisions of this API.