v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

WhatsApp Campaigns

Return all your created WhatsApp campaigns

get/whatsappCampaigns

Query parameters

startDatestring

Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. Prefer to pass your timezone in date-time format for accurate result

endDatestring

Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. Prefer to pass your timezone in date-time format for accurate result

limitinteger

Number of documents per page

offsetinteger

Index of the first document in the page

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record modification. Default order is descending if sort is not passed

Response

WhatsApp campaigns informations

countinteger

Number of WhatsApp campaigns retrived

Example response

{
  "campaigns": [
    {
      "id": 1672035851100690,
      "campaignName": "Test Campaign",
      "templateId": "637660278078655",
      "campaignStatus": "draft",
      "scheduledAt": "2017-06-01T12:30:00.000+0000",
      "errorReason": "NONE",
      "readPercentage": 28.57,
      "stats": {
        "sent": 3,
        "delivered": 3,
        "read": 2,
        "not_sent": 4
      },
      "createdAt": "2017-06-01T12:30:00.000+0000",
      "modifiedAt": "2017-05-01T12:30:00.000+0000"
    }
  ],
  "count": 24
}