Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
WhatsApp Campaigns

Get a WhatsApp campaign

get/whatsappCampaigns/{campaignId}

Path parameters

campaignIdinteger required

Id of the campaign

Response

Get WhatsApp campaign information on the basis of campaignId

idinteger required

ID of the WhatsApp Campaign

campaignNamestring required

Name of the WhatsApp Campaign

campaignStatus'draft' | 'scheduled' | 'pending' | 'approved' | 'running' | 'suspended' | 'rejected' | 'sent' required

Status of the WhatsApp Campaign

scheduledAtstring

UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format

senderNumberstring required

Sender of the WhatsApp Campaign

createdAtstring required

Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

modifiedAtstring required

UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

Example response

{
  "id": 1672035851100690,
  "campaignName": "Test Campaign",
  "campaignStatus": "draft",
  "scheduledAt": "2017-06-01T12:30:00.000+0000",
  "senderNumber": "9368207029",
  "stats": {
    "sent": 3,
    "delivered": 3,
    "read": 2,
    "not_sent": 4
  },
  "template": {
    "name": "wta107",
    "category": "Marketing",
    "language": "en_GB",
    "display_header": true,
    "header_type": "text",
    "components": [
      {
        "type": "BODY",
        "text": "Life is a long lesson in humility"
      }
    ],
    "header_variables": [
      {
        "name": "FIRSTNAME",
        "default": "INVALID_HEADER",
        "datatype": "text"
      }
    ],
    "body_variables": [
      {
        "name": "FIRSTNAME",
        "default": "INVALID_HEADER",
        "datatype": "text"
      }
    ],
    "button_type": "QUICK_REPLIES",
    "hide_footer": true
  },
  "createdAt": "2017-06-01T12:30:00.000+0000",
  "modifiedAt": "2017-05-01T12:30:00.000+0000"
}