Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Trigger Broadcast

API to trigger broadcast notification to list users.

post/{workspace_key}/broadcast/

Path parameters

workspace_keystring required

unique identifier of your workspace

Request body

list_idstring required

unique identifier to user list that you want to send broadcast messages to.

templatestring required

Unique slug name of the template created on SuprSend dashboard. You can get this by clicking on the clipboard icon next to the Template name on SuprSend templates page.

notification_categorystring required

Category in which your notification belongs. You can understand more about them in the Notification Category documentation

channelsstring[]

If set, broadcast will be sent only on the channels defined here irrespective of communication channels present in user profile.

dataobject

Mock data to replace the template variables.

delaystring

Broadcast will be halted for the time mentioned in delay, and become active once the delay period is over. Format - XXdXXhXXmXXs or if its number (n) then delay is in seconds (n)

trigger_atstring date

Trigger broadcast on a specific date-time. Format - date string in ISO 8601 e.g. "2022-08-27T20:14:51.643Z"

tenant_idstring

string identifier of the tenant this broadcast is associated with

Response

202 - Accepted

messagestring

Status message indicating the broadcast was accepted.

Example response

{
  "message": "Accepted - OK"
}