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.

get

/v1/broadcasts

Authorizations

Query parameters

limitstring

endDatestring

locationIdstring

pagestring

startDatestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/broadcasts' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "status": "text",
    "scheduleDateTime": "text",
    "startedAt": "text",
    "completedAt": "text",
    "headerMediaUrl": "text",
    "type": "client",
    "targetClassStatus": "ALL",
    "retargetEngagementType": "sent",
    "headerTextParameters": [
      "text"
    ],
    "bodyTextParameters": [
      "text"
    ],
    "buttonUrlParameters": [
      "text"
    ],
    "targetClass": {
      "id": "text"
    },
    "retargetBroadcast": {
      "id": "text"
    },
    "template": {
      "name": "text",
      "language": "text"
    },
    "locationParameters": {
      "latitude": 1,
      "longitude": 1,
      "address": "text",
      "name": "text"
    },
    "flowParameters": {
      "flowToken": "text",
      "flowData": "text"
    },
    "location": {
      "id": "text"
    },
    "processedStats": {
      "totalCount": 1,
      "successCount": 1,
      "failureCount": 1
    },
    "deliveryStats": {
      "sentCount": 1,
      "deliveredCount": 1,
      "readCount": 1,
      "failedCount": 1,
      "repliedCount": 1
    },
    "segments": [
      {
        "id": "text"
      }
    ]
  }
]

200 response

post

/v1/broadcasts

Authorizations

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

statusstring

scheduleDateTimestring

startedAtstring

completedAtstring

headerMediaUrlstring

typestring · enumrequired

Options: client, contact, class, retarget

targetClassStatusstring · enum

Options: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED

retargetEngagementTypestring · enum

Options: sent, delivered, read, replied, not-replied

headerTextParametersstring[]

bodyTextParametersstring[]

buttonUrlParametersstring[]

targetClassobject

retargetBroadcastobject

templateobject

locationParametersobject

flowParametersobject

locationobjectrequired

processedStatsobject

deliveryStatsobject

segmentsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/broadcasts' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","type":"client","targetClassStatus":"ALL","retargetEngagementType":"sent","headerTextParameters":[null],"bodyTextParameters":[null],"buttonUrlParameters":[null],"targetClass":{"id":"text"},"retargetBroadcast":{"id":"text"},"template":{"name":"text","language":"text"},"locationParameters":{"latitude":1,"longitude":1,"address":"text","name":"text"},"flowParameters":{"flowToken":"text","flowData":"text"},"location":{"id":"text"},"processedStats":{},"deliveryStats":{},"segments":[{"id":"text"}]}'

200

200

{
  "id": "text",
  "name": "text",
  "status": "text",
  "scheduleDateTime": "text",
  "startedAt": "text",
  "completedAt": "text",
  "headerMediaUrl": "text",
  "type": "client",
  "targetClassStatus": "ALL",
  "retargetEngagementType": "sent",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "targetClass": {
    "id": "text"
  },
  "retargetBroadcast": {
    "id": "text"
  },
  "template": {
    "name": "text",
    "language": "text"
  },
  "locationParameters": {
    "latitude": 1,
    "longitude": 1,
    "address": "text",
    "name": "text"
  },
  "flowParameters": {
    "flowToken": "text",
    "flowData": "text"
  },
  "location": {
    "id": "text"
  },
  "processedStats": {
    "totalCount": 1,
    "successCount": 1,
    "failureCount": 1
  },
  "deliveryStats": {
    "sentCount": 1,
    "deliveredCount": 1,
    "readCount": 1,
    "failedCount": 1,
    "repliedCount": 1
  },
  "segments": [
    {
      "id": "text"
    }
  ]
}

200 response

get

/v1/broadcasts/{broadcastId}

Authorizations

Path parameters

broadcastIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/broadcasts/{broadcastId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "name": "text",
  "status": "text",
  "scheduleDateTime": "text",
  "startedAt": "text",
  "completedAt": "text",
  "headerMediaUrl": "text",
  "type": "client",
  "targetClassStatus": "ALL",
  "retargetEngagementType": "sent",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "targetClass": {
    "id": "text"
  },
  "retargetBroadcast": {
    "id": "text"
  },
  "template": {
    "name": "text",
    "language": "text"
  },
  "locationParameters": {
    "latitude": 1,
    "longitude": 1,
    "address": "text",
    "name": "text"
  },
  "flowParameters": {
    "flowToken": "text",
    "flowData": "text"
  },
  "location": {
    "id": "text"
  },
  "processedStats": {
    "totalCount": 1,
    "successCount": 1,
    "failureCount": 1
  },
  "deliveryStats": {
    "sentCount": 1,
    "deliveredCount": 1,
    "readCount": 1,
    "failedCount": 1,
    "repliedCount": 1
  },
  "segments": [
    {
      "id": "text"
    }
  ]
}

200 response

put

/v1/broadcasts/{broadcastId}

Authorizations

Path parameters

broadcastIdstringrequired

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

statusstring

scheduleDateTimestring

startedAtstring

completedAtstring

headerMediaUrlstring

typestring · enumrequired

Options: client, contact, class, retarget

targetClassStatusstring · enum

Options: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED

retargetEngagementTypestring · enum

Options: sent, delivered, read, replied, not-replied

headerTextParametersstring[]

bodyTextParametersstring[]

buttonUrlParametersstring[]

targetClassobject

retargetBroadcastobject

templateobject

locationParametersobject

flowParametersobject

locationobjectrequired

processedStatsobject

deliveryStatsobject

segmentsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '<YOUR HOST>/v1/broadcasts/{broadcastId}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","type":"client","targetClassStatus":"ALL","retargetEngagementType":"sent","headerTextParameters":[null],"bodyTextParameters":[null],"buttonUrlParameters":[null],"targetClass":{"id":"text"},"retargetBroadcast":{"id":"text"},"template":{"name":"text","language":"text"},"locationParameters":{"latitude":1,"longitude":1,"address":"text","name":"text"},"flowParameters":{"flowToken":"text","flowData":"text"},"location":{"id":"text"},"processedStats":{},"deliveryStats":{},"segments":[{"id":"text"}]}'

200

200

{
  "id": "text",
  "name": "text",
  "status": "text",
  "scheduleDateTime": "text",
  "startedAt": "text",
  "completedAt": "text",
  "headerMediaUrl": "text",
  "type": "client",
  "targetClassStatus": "ALL",
  "retargetEngagementType": "sent",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "targetClass": {
    "id": "text"
  },
  "retargetBroadcast": {
    "id": "text"
  },
  "template": {
    "name": "text",
    "language": "text"
  },
  "locationParameters": {
    "latitude": 1,
    "longitude": 1,
    "address": "text",
    "name": "text"
  },
  "flowParameters": {
    "flowToken": "text",
    "flowData": "text"
  },
  "location": {
    "id": "text"
  },
  "processedStats": {
    "totalCount": 1,
    "successCount": 1,
    "failureCount": 1
  },
  "deliveryStats": {
    "sentCount": 1,
    "deliveredCount": 1,
    "readCount": 1,
    "failedCount": 1,
    "repliedCount": 1
  },
  "segments": [
    {
      "id": "text"
    }
  ]
}

200 response

delete

/v1/broadcasts/{broadcastId}

Authorizations

Path parameters

broadcastIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '<YOUR HOST>/v1/broadcasts/{broadcastId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response

get

/v1/broadcasts/{broadcastId}/logs

Authorizations

Path parameters

broadcastIdstringrequired

Query parameters

limitstring

pagestring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/broadcasts/{broadcastId}/logs' \
  --header 'x-api-key: text'

200

200

[
  {
    "recepientName": "text",
    "countryCode": "text",
    "phone": "text",
    "reply": "text",
    "error": "text",
    "createdAt": "2025-02-23T10:15:05.431Z",
    "updatedAt": "2025-02-23T10:15:05.431Z",
    "status": "read",
    "broadcast": {
      "id": "text",
      "name": "text"
    }
  }
]

200 response