---
title: "Trigger Broadcast"
method: POST
path: "/{workspace_key}/broadcast/"
---

# Trigger Broadcast

`POST /{workspace_key}/broadcast/`

API to trigger broadcast notification to list users.

## Path parameters

- `workspace_key` string, required

## Request body

- object
  - `list_id` string, required — unique identifier to user list that you want to send broadcast messages to.
  - `template` string, 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_category` string, required — Category in which your notification belongs. You can understand more about them in the [Notification Category](https://docs.suprsend.com/docs/notification-category) documentation
  - `channels` string[] — If set, broadcast will be sent only on the channels defined here irrespective of communication channels present in user profile.
  - `data` object — Mock data to replace the template variables.
  - `delay` string — 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_at` string, date — Trigger broadcast on a specific date-time. Format - date string in ISO 8601 e.g. "2022-08-27T20:14:51.643Z"
  - `tenant_id` string — string identifier of the tenant this broadcast is associated with

## Response `202`

202 - Accepted

- object — Confirmation that the broadcast request was accepted for processing.
  - `message` string — Status message indicating the broadcast was accepted.

## Other responses

- `400` — 400 - Bad Request

---

[API](https://skmtc.net/suprsend/apis/suprsend-api.md) · [All operations](https://skmtc.net/suprsend/apis/suprsend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/suprsend/suprsend-api/versions/8bd2574bd2c3/schema)