Broadcasts

The Broadcasts CRUD API empowers users to manage messaging broadcasts seamlessly, offering Create, Read, Update, and Delete operations.

This API feature set enables scheduling broadcasts on WhatsApp. Please make sure the scheduleDateTime parameter adheres to UTC for precise timing.

GEThttps://<YOUR HOST>/v1/broadcasts

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

fullName*string

contactTypeenum

HOMEMOBILEWORK

countryCode*string

phone*string

emailstring

registrationDatestring

dobstring

addressTypeenum

HOMEWORK

addressstring

genderenum

MaleFemaleUnknownOther

maritalStatusenum

UNMARRIEDMARRIEDOTHER

tagsarray of string

notesstring

referralSourcestring

primaryLocationobject

primaryStaffobject

customFieldsobject

photostring (uri)

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/broadcasts', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "fullName": "text",
    "contactType": "HOME",
    "countryCode": "text",
    "phone": "text",
    "email": "text",
    "registrationDate": "text",
    "dob": "text",
    "addressType": "HOME",
    "address": "text",
    "gender": "Male",
    "maritalStatus": "UNMARRIED",
    "tags": [
      "text"
    ],
    "notes": "text",
    "referralSource": "text",
    "primaryLocation": {
      "id": "text",
      "title": "text"
    },
    "primaryStaff": {
      "id": "text"
    },
    "customFields": {},
    "photo": "https://example.com",
    "emergencyRelationType": "text",
    "emergencyName": "text",
    "emergencyCountryCode": "text",
    "identificationNumber": "text",
    "emergencyPhone": "text"
  }
]

GEThttps://<YOUR HOST>/v1/broadcasts/{broadcastId}

Path parameters

broadcastId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

type*enum

clientcontactretarget

statusstring

segmentsarray of object

retargetBroadcastobject

retargetEngagementTypeenum

sentdeliveredreadreplied

scheduleDateTimestring

startedAtstring

completedAtstring

templateobject

headerMediaUrlstring

headerTextParametersarray of string

bodyTextParametersarray of string

buttonUrlParametersarray of string

location*object

processedStatsobject

deliveryStatsobject

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/broadcasts/{broadcastId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "type": "client",
  "status": "text",
  "segments": [
    {
      "id": "text"
    }
  ],
  "retargetBroadcast": {
    "id": "text"
  },
  "retargetEngagementType": "sent",
  "scheduleDateTime": "text",
  "startedAt": "text",
  "completedAt": "text",
  "template": {
    "name": "text",
    "language": "text"
  },
  "headerMediaUrl": "text",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "location": {
    "id": "text"
  },
  "processedStats": {
    "totalCount": 0,
    "successCount": 0,
    "failureCount": 0
  },
  "deliveryStats": {
    "sentCount": 0,
    "deliveredCount": 0,
    "readCount": 0,
    "failedCount": 0,
    "repliedCount": 0
  }
}

DELETEhttps://<YOUR HOST>/v1/broadcasts/{broadcastId}

Path parameters

broadcastId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/broadcasts/{broadcastId}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false
}

GEThttps://<YOUR HOST>/v1/broadcasts/{broadcastId}/logs

Path parameters

broadcastId*string

Query parameters

Header parameters

Response

200

200 response

Body

application/json

broadcastobject

recepientNamestring

countryCodestring

phonestring

Pattern: ^[0-9]+$

statusenum

readsentdelivered

replystring

errorstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/broadcasts/{broadcastId}/logs', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "broadcast": {
      "id": "text",
      "name": "text"
    },
    "recepientName": "text",
    "countryCode": "text",
    "phone": "text",
    "status": "read",
    "reply": "text",
    "error": "text",
    "createdAt": "2024-10-13T03:41:43.371Z",
    "updatedAt": "2024-10-13T03:41:43.371Z"
  }
]