SUsuprsend

Trigger Broadcast

Changed on

API to trigger broadcast notification to list users.

post/{workspace_key}/broadcast/

Request

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-time

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

precomputeboolean

When true, SuprSend prepares the send plan (list snapshot, preferences and rendered messages) before the scheduled time set by trigger_at or delay, so sending starts at the scheduled time. Only applies to scheduled broadcasts; ignored when trigger_at and delay are both absent. See Precompute a scheduled broadcast for the full behavior, what happens to changes after the snapshot, and log events.

tenant_idstring

string identifier of the tenant this broadcast is associated with

cancellation_keystring

Lookup key stored on the running execution(s) so a Cancel Workflow node can later stop them by matching on it. Pass a literal string (max 512 characters; longer values are truncated). Overrides the target workflow's own Trigger-node Cancellation Key expression when both are present.

Example request

{
  "cancellation_key": "booking-123"
}

Response

202 - Accepted

Changes