Skip to main content

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.

API regionapi.whautomate.com

GET /v1/broadcasts​

GET /v1/broadcasts
Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
limitstring
endDatestring
locationIdstring
pagestring
startDatestring
searchTextstring
Response 200
idstring
namestringrequired
typestring (enum)required
One of: client, contact, class, retarget.
statusstring
segmentsobject[]
targetClassobject
targetClassStatusstring (enum)
One of: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED.
retargetBroadcastobject
retargetEngagementTypestring (enum)
One of: sent, delivered, read, replied, not-replied.
scheduleDateTimestring
startedAtstring
completedAtstring
templateobject
headerMediaUrlstring
headerTextParametersstring[]
bodyTextParametersstring[]
buttonUrlParametersstring[]
locationParametersobject
flowParametersobject
locationobjectrequired
processedStatsobject
deliveryStatsobject
Request
curl -X GET "https://api.whautomate.com/v1/broadcasts" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "string",
    "name": "string",
    "type": "client",
    "status": "string",
    "segments": [
      {
        "id": "string"
      }
    ],
    "targetClass": {
      "id": "string"
    },
    "targetClassStatus": "ALL",
    "retargetBroadcast": {
      "id": "string"
    },
    "retargetEngagementType": "sent",
    "scheduleDateTime": "string",
    "startedAt": "string",
    "completedAt": "string",
    "template": {
      "name": "string",
      "language": "string"
    },
    "headerMediaUrl": "string",
    "headerTextParameters": [
      "string"
    ],
    "bodyTextParameters": [
      "string"
    ],
    "buttonUrlParameters": [
      "string"
    ],
    "locationParameters": {
      "latitude": 0,
      "longitude": 0,
      "address": "string",
      "name": "string"
    },
    "flowParameters": {
      "flowToken": "string",
      "flowData": "string"
    },
    "location": {
      "id": "string"
    },
    "processedStats": {
      "totalCount": 0,
      "successCount": 0,
      "failureCount": 0
    },
    "deliveryStats": {
      "sentCount": 0,
      "deliveredCount": 0,
      "readCount": 0,
      "failedCount": 0,
      "repliedCount": 0
    }
  }
]

POST /v1/broadcasts​

POST /v1/broadcasts
Headers
x-api-keystringrequired
Your Whautomate API key.
Body
idstring
namestringrequired
typestring (enum)required
One of: client, contact, class, retarget.
statusstring
segmentsobject[]
targetClassobject
targetClassStatusstring (enum)
One of: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED.
retargetBroadcastobject
retargetEngagementTypestring (enum)
One of: sent, delivered, read, replied, not-replied.
scheduleDateTimestring
startedAtstring
completedAtstring
templateobject
headerMediaUrlstring
headerTextParametersstring[]
bodyTextParametersstring[]
buttonUrlParametersstring[]
locationParametersobject
flowParametersobject
locationobjectrequired
processedStatsobject
deliveryStatsobject
Response 200
idstring
namestringrequired
typestring (enum)required
One of: client, contact, class, retarget.
statusstring
segmentsobject[]
targetClassobject
targetClassStatusstring (enum)
One of: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED.
retargetBroadcastobject
retargetEngagementTypestring (enum)
One of: sent, delivered, read, replied, not-replied.
scheduleDateTimestring
startedAtstring
completedAtstring
templateobject
headerMediaUrlstring
headerTextParametersstring[]
bodyTextParametersstring[]
buttonUrlParametersstring[]
locationParametersobject
flowParametersobject
locationobjectrequired
processedStatsobject
deliveryStatsobject
Request
curl -X POST "https://api.whautomate.com/v1/broadcasts" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "type": "client",
    "status": "string",
    "segments": [
      {
        "id": "string"
      }
    ],
    "targetClass": {
      "id": "string"
    },
    "targetClassStatus": "ALL",
    "retargetBroadcast": {
      "id": "string"
    },
    "retargetEngagementType": "sent",
    "scheduleDateTime": "string",
    "startedAt": "string",
    "completedAt": "string",
    "template": {
      "name": "string",
      "language": "string"
    },
    "headerMediaUrl": "string",
    "headerTextParameters": [
      "string"
    ],
    "bodyTextParameters": [
      "string"
    ],
    "buttonUrlParameters": [
      "string"
    ],
    "locationParameters": {
      "latitude": 0,
      "longitude": 0,
      "address": "string",
      "name": "string"
    },
    "flowParameters": {
      "flowToken": "string",
      "flowData": "string"
    },
    "location": {
      "id": "string"
    },
    "processedStats": {
      "totalCount": 0,
      "successCount": 0,
      "failureCount": 0
    },
    "deliveryStats": {
      "sentCount": 0,
      "deliveredCount": 0,
      "readCount": 0,
      "failedCount": 0,
      "repliedCount": 0
    }
  }'
Response 200
{
  "id": "string",
  "name": "string",
  "type": "client",
  "status": "string",
  "segments": [
    {
      "id": "string"
    }
  ],
  "targetClass": {
    "id": "string"
  },
  "targetClassStatus": "ALL",
  "retargetBroadcast": {
    "id": "string"
  },
  "retargetEngagementType": "sent",
  "scheduleDateTime": "string",
  "startedAt": "string",
  "completedAt": "string",
  "template": {
    "name": "string",
    "language": "string"
  },
  "headerMediaUrl": "string",
  "headerTextParameters": [
    "string"
  ],
  "bodyTextParameters": [
    "string"
  ],
  "buttonUrlParameters": [
    "string"
  ],
  "locationParameters": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "name": "string"
  },
  "flowParameters": {
    "flowToken": "string",
    "flowData": "string"
  },
  "location": {
    "id": "string"
  },
  "processedStats": {
    "totalCount": 0,
    "successCount": 0,
    "failureCount": 0
  },
  "deliveryStats": {
    "sentCount": 0,
    "deliveredCount": 0,
    "readCount": 0,
    "failedCount": 0,
    "repliedCount": 0
  }
}

GET /v1/broadcasts/{broadcastId}​

GET /v1/broadcasts/{broadcastId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
broadcastIdstringrequired
Response 200
idstring
namestringrequired
typestring (enum)required
One of: client, contact, class, retarget.
statusstring
segmentsobject[]
targetClassobject
targetClassStatusstring (enum)
One of: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED.
retargetBroadcastobject
retargetEngagementTypestring (enum)
One of: sent, delivered, read, replied, not-replied.
scheduleDateTimestring
startedAtstring
completedAtstring
templateobject
headerMediaUrlstring
headerTextParametersstring[]
bodyTextParametersstring[]
buttonUrlParametersstring[]
locationParametersobject
flowParametersobject
locationobjectrequired
processedStatsobject
deliveryStatsobject
Request
curl -X GET "https://api.whautomate.com/v1/broadcasts/{broadcastId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "name": "string",
  "type": "client",
  "status": "string",
  "segments": [
    {
      "id": "string"
    }
  ],
  "targetClass": {
    "id": "string"
  },
  "targetClassStatus": "ALL",
  "retargetBroadcast": {
    "id": "string"
  },
  "retargetEngagementType": "sent",
  "scheduleDateTime": "string",
  "startedAt": "string",
  "completedAt": "string",
  "template": {
    "name": "string",
    "language": "string"
  },
  "headerMediaUrl": "string",
  "headerTextParameters": [
    "string"
  ],
  "bodyTextParameters": [
    "string"
  ],
  "buttonUrlParameters": [
    "string"
  ],
  "locationParameters": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "name": "string"
  },
  "flowParameters": {
    "flowToken": "string",
    "flowData": "string"
  },
  "location": {
    "id": "string"
  },
  "processedStats": {
    "totalCount": 0,
    "successCount": 0,
    "failureCount": 0
  },
  "deliveryStats": {
    "sentCount": 0,
    "deliveredCount": 0,
    "readCount": 0,
    "failedCount": 0,
    "repliedCount": 0
  }
}

PUT /v1/broadcasts/{broadcastId}​

PUT /v1/broadcasts/{broadcastId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
broadcastIdstringrequired
Body
idstring
namestringrequired
typestring (enum)required
One of: client, contact, class, retarget.
statusstring
segmentsobject[]
targetClassobject
targetClassStatusstring (enum)
One of: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED.
retargetBroadcastobject
retargetEngagementTypestring (enum)
One of: sent, delivered, read, replied, not-replied.
scheduleDateTimestring
startedAtstring
completedAtstring
templateobject
headerMediaUrlstring
headerTextParametersstring[]
bodyTextParametersstring[]
buttonUrlParametersstring[]
locationParametersobject
flowParametersobject
locationobjectrequired
processedStatsobject
deliveryStatsobject
Response 200
idstring
namestringrequired
typestring (enum)required
One of: client, contact, class, retarget.
statusstring
segmentsobject[]
targetClassobject
targetClassStatusstring (enum)
One of: ALL, WAITLISTED, BOOKED, VISITED, RESCHEDULED, NO_SHOW, CANCELLED.
retargetBroadcastobject
retargetEngagementTypestring (enum)
One of: sent, delivered, read, replied, not-replied.
scheduleDateTimestring
startedAtstring
completedAtstring
templateobject
headerMediaUrlstring
headerTextParametersstring[]
bodyTextParametersstring[]
buttonUrlParametersstring[]
locationParametersobject
flowParametersobject
locationobjectrequired
processedStatsobject
deliveryStatsobject
Request
curl -X PUT "https://api.whautomate.com/v1/broadcasts/{broadcastId}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "type": "client",
    "status": "string",
    "segments": [
      {
        "id": "string"
      }
    ],
    "targetClass": {
      "id": "string"
    },
    "targetClassStatus": "ALL",
    "retargetBroadcast": {
      "id": "string"
    },
    "retargetEngagementType": "sent",
    "scheduleDateTime": "string",
    "startedAt": "string",
    "completedAt": "string",
    "template": {
      "name": "string",
      "language": "string"
    },
    "headerMediaUrl": "string",
    "headerTextParameters": [
      "string"
    ],
    "bodyTextParameters": [
      "string"
    ],
    "buttonUrlParameters": [
      "string"
    ],
    "locationParameters": {
      "latitude": 0,
      "longitude": 0,
      "address": "string",
      "name": "string"
    },
    "flowParameters": {
      "flowToken": "string",
      "flowData": "string"
    },
    "location": {
      "id": "string"
    },
    "processedStats": {
      "totalCount": 0,
      "successCount": 0,
      "failureCount": 0
    },
    "deliveryStats": {
      "sentCount": 0,
      "deliveredCount": 0,
      "readCount": 0,
      "failedCount": 0,
      "repliedCount": 0
    }
  }'
Response 200
{
  "id": "string",
  "name": "string",
  "type": "client",
  "status": "string",
  "segments": [
    {
      "id": "string"
    }
  ],
  "targetClass": {
    "id": "string"
  },
  "targetClassStatus": "ALL",
  "retargetBroadcast": {
    "id": "string"
  },
  "retargetEngagementType": "sent",
  "scheduleDateTime": "string",
  "startedAt": "string",
  "completedAt": "string",
  "template": {
    "name": "string",
    "language": "string"
  },
  "headerMediaUrl": "string",
  "headerTextParameters": [
    "string"
  ],
  "bodyTextParameters": [
    "string"
  ],
  "buttonUrlParameters": [
    "string"
  ],
  "locationParameters": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "name": "string"
  },
  "flowParameters": {
    "flowToken": "string",
    "flowData": "string"
  },
  "location": {
    "id": "string"
  },
  "processedStats": {
    "totalCount": 0,
    "successCount": 0,
    "failureCount": 0
  },
  "deliveryStats": {
    "sentCount": 0,
    "deliveredCount": 0,
    "readCount": 0,
    "failedCount": 0,
    "repliedCount": 0
  }
}

DELETE /v1/broadcasts/{broadcastId}​

DEL /v1/broadcasts/{broadcastId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
broadcastIdstringrequired
Response 200
successboolean
Request
curl -X DELETE "https://api.whautomate.com/v1/broadcasts/{broadcastId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "success": true
}

GET /v1/broadcasts/{broadcastId}/logs​

GET /v1/broadcasts/{broadcastId}/logs
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
broadcastIdstringrequired
Query parameters
limitstring
pagestring
Response 200
broadcastobject
recepientNamestring
countryCodestring
phonestring
statusstring (enum)
One of: read, sent, delivered.
replystring
errorstring
createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/broadcasts/{broadcastId}/logs" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "broadcast": {
      "id": "string",
      "name": "string"
    },
    "recepientName": "string",
    "countryCode": "string",
    "phone": "string",
    "status": "read",
    "reply": "string",
    "error": "string",
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
]
Last updated on