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
Authorizations
Query parameters
limitstringOptional
endDatestringOptional
locationIdstringOptional
pagestringOptional
startDatestringOptional
searchTextstringOptional
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/broadcasts HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200
200 response
[
{
"id": "text",
"name": "text",
"type": "client",
"status": "text",
"segments": [
{
"id": "text"
}
],
"targetClass": {
"id": "text"
},
"targetClassStatus": "ALL",
"retargetBroadcast": {
"id": "text"
},
"retargetEngagementType": "sent",
"scheduleDateTime": "text",
"startedAt": "text",
"completedAt": "text",
"template": {
"name": "text",
"language": "text"
},
"headerMediaUrl": "text",
"headerTextParameters": [
"text"
],
"bodyTextParameters": [
"text"
],
"buttonUrlParameters": [
"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
}
}
]post
Authorizations
Header parameters
x-api-keystringRequired
Body
idstringOptional
namestringRequired
typestring · enumRequiredPossible values:
statusstringOptional
targetClassStatusstring · enumOptionalPossible values:
retargetEngagementTypestring · enumOptionalPossible values:
scheduleDateTimestringOptional
startedAtstringOptional
completedAtstringOptional
headerMediaUrlstringOptional
headerTextParametersstring[]Optional
bodyTextParametersstring[]Optional
buttonUrlParametersstring[]Optional
Responses
200
200 response
application/json
post
POST /v1/broadcasts HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 762
{
"id": "text",
"name": "text",
"type": "client",
"status": "text",
"segments": [
{
"id": "text"
}
],
"targetClass": {
"id": "text"
},
"targetClassStatus": "ALL",
"retargetBroadcast": {
"id": "text"
},
"retargetEngagementType": "sent",
"scheduleDateTime": "text",
"startedAt": "text",
"completedAt": "text",
"template": {
"name": "text",
"language": "text"
},
"headerMediaUrl": "text",
"headerTextParameters": [
"text"
],
"bodyTextParameters": [
"text"
],
"buttonUrlParameters": [
"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
}
}200
200 response
{
"id": "text",
"name": "text",
"type": "client",
"status": "text",
"segments": [
{
"id": "text"
}
],
"targetClass": {
"id": "text"
},
"targetClassStatus": "ALL",
"retargetBroadcast": {
"id": "text"
},
"retargetEngagementType": "sent",
"scheduleDateTime": "text",
"startedAt": "text",
"completedAt": "text",
"template": {
"name": "text",
"language": "text"
},
"headerMediaUrl": "text",
"headerTextParameters": [
"text"
],
"bodyTextParameters": [
"text"
],
"buttonUrlParameters": [
"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
}
}get
Authorizations
Path parameters
broadcastIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/broadcasts/{broadcastId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200
200 response
{
"id": "text",
"name": "text",
"type": "client",
"status": "text",
"segments": [
{
"id": "text"
}
],
"targetClass": {
"id": "text"
},
"targetClassStatus": "ALL",
"retargetBroadcast": {
"id": "text"
},
"retargetEngagementType": "sent",
"scheduleDateTime": "text",
"startedAt": "text",
"completedAt": "text",
"template": {
"name": "text",
"language": "text"
},
"headerMediaUrl": "text",
"headerTextParameters": [
"text"
],
"bodyTextParameters": [
"text"
],
"buttonUrlParameters": [
"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
}
}put
Authorizations
Path parameters
broadcastIdstringRequired
Header parameters
x-api-keystringRequired
Body
idstringOptional
namestringRequired
typestring · enumRequiredPossible values:
statusstringOptional
targetClassStatusstring · enumOptionalPossible values:
retargetEngagementTypestring · enumOptionalPossible values:
scheduleDateTimestringOptional
startedAtstringOptional
completedAtstringOptional
headerMediaUrlstringOptional
headerTextParametersstring[]Optional
bodyTextParametersstring[]Optional
buttonUrlParametersstring[]Optional
Responses
200
200 response
application/json
put
PUT /v1/broadcasts/{broadcastId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 762
{
"id": "text",
"name": "text",
"type": "client",
"status": "text",
"segments": [
{
"id": "text"
}
],
"targetClass": {
"id": "text"
},
"targetClassStatus": "ALL",
"retargetBroadcast": {
"id": "text"
},
"retargetEngagementType": "sent",
"scheduleDateTime": "text",
"startedAt": "text",
"completedAt": "text",
"template": {
"name": "text",
"language": "text"
},
"headerMediaUrl": "text",
"headerTextParameters": [
"text"
],
"bodyTextParameters": [
"text"
],
"buttonUrlParameters": [
"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
}
}200
200 response
{
"id": "text",
"name": "text",
"type": "client",
"status": "text",
"segments": [
{
"id": "text"
}
],
"targetClass": {
"id": "text"
},
"targetClassStatus": "ALL",
"retargetBroadcast": {
"id": "text"
},
"retargetEngagementType": "sent",
"scheduleDateTime": "text",
"startedAt": "text",
"completedAt": "text",
"template": {
"name": "text",
"language": "text"
},
"headerMediaUrl": "text",
"headerTextParameters": [
"text"
],
"bodyTextParameters": [
"text"
],
"buttonUrlParameters": [
"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
}
}delete
Authorizations
Path parameters
broadcastIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
delete
DELETE /v1/broadcasts/{broadcastId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200
200 response
{
"success": true
}get
Authorizations
Path parameters
broadcastIdstringRequired
Query parameters
limitstringOptional
pagestringOptional
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/broadcasts/{broadcastId}/logs HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200
200 response
[
{
"broadcast": {
"id": "text",
"name": "text"
},
"recepientName": "text",
"countryCode": "text",
"phone": "text",
"status": "read",
"reply": "text",
"error": "text",
"createdAt": "2025-06-21T15:07:40.248Z",
"updatedAt": "2025-06-21T15:07:40.248Z"
}
]Last updated