Skip to main content
POST
/
{workspace_key}
/
broadcast
Trigger Broadcast
curl -X POST "https://hub.suprsend.com/{workspace_key}/broadcast" \
  --header 'Authorization: Bearer __YOUR_API_KEY__' \
  --header 'Content-Type: application/json' \
  --data '{
    "list_id": "_list_id_",
    "template": "_template_slug_",
    "notification_category": "transactional",
    "data": {
      "user_name": "John Doe",
      "product_name": "Premium Plan"
    }
  }'
"Ok"

Authorizations

​
Authorization
string
header
required

Path Parameters

​
workspace_key
string
required

Body

application/json
​
list_id
string
default:_list_id_
required
​
template
string
default:_template_slug_
required
​
notification_category
string
default:transactional
required
​
channels
string[]
​
data
object
​
delay
string
​
trigger_at
string<date>
​
tenant_id
string

Response

​
message
string
Example: