Trigger Broadcast

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"
    }
  }'

import requests

url = "https://hub.suprsend.com/{workspace_key}/broadcast/"

payload = {
    "list_id": "_list_id_",
    "template": "_template_slug_",
    "notification_category": "transactional",
    "channels": ["<string>"],
    "data": {},
    "delay": "<string>",
    "trigger_at": "2023-11-07T05:31:56Z",
    "precompute": False,
    "tenant_id": "<string>",
    "cancellation_key": "booking-123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    list_id: '_list_id_',
    template: '_template_slug_',
    notification_category: 'transactional',
    channels: ['<string>'],
    data: {},
    delay: '<string>',
    trigger_at: '2023-11-07T05:31:56Z',
    precompute: false,
    tenant_id: '<string>',
    cancellation_key: 'booking-123'
  })
};

fetch('https://hub.suprsend.com/{workspace_key}/broadcast/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://hub.suprsend.com/{workspace_key}/broadcast/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'list_id' => '_list_id_',
    'template' => '_template_slug_',
    'notification_category' => 'transactional',
    'channels' => [
        '<string>'
    ],
    'data' => [
        
    ],
    'delay' => '<string>',
    'trigger_at' => '2023-11-07T05:31:56Z',
    'precompute' => false,
    'tenant_id' => '<string>',
    'cancellation_key' => 'booking-123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://hub.suprsend.com/{workspace_key}/broadcast/"

	payload := strings.NewReader("{\n  \"list_id\": \"_list_id_\",\n  \"template\": \"_template_slug_\",\n  \"notification_category\": \"transactional\",\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"data\": {},\n  \"delay\": \"<string>\",\n  \"trigger_at\": \"2023-11-07T05:31:56Z\",\n  \"precompute\": false,\n  \"tenant_id\": \"<string>\",\n  \"cancellation_key\": \"booking-123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://hub.suprsend.com/{workspace_key}/broadcast/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"list_id\": \"_list_id_\",\n  \"template\": \"_template_slug_\",\n  \"notification_category\": \"transactional\",\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"data\": {},\n  \"delay\": \"<string>\",\n  \"trigger_at\": \"2023-11-07T05:31:56Z\",\n  \"precompute\": false,\n  \"tenant_id\": \"<string>\",\n  \"cancellation_key\": \"booking-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://hub.suprsend.com/{workspace_key}/broadcast/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"list_id\": \"_list_id_\",\n  \"template\": \"_template_slug_\",\n  \"notification_category\": \"transactional\",\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"data\": {},\n  \"delay\": \"<string>\",\n  \"trigger_at\": \"2023-11-07T05:31:56Z\",\n  \"precompute\": false,\n  \"tenant_id\": \"<string>\",\n  \"cancellation_key\": \"booking-123\"\n}"

response = http.request(request)
puts response.read_body

OK

BAD REQUEST

Authorizations

Authorization

string

header

required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

workspace_key

string

required

unique identifier of your workspace

Body

application/json

list_id

string

default:_list_id_

required

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

Pattern: ^[a-z0-9_-]+$

template

string

default:_template_slug_

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

default:transactional

required

Category in which your notification belongs. You can understand more about them in the 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-time>

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

precompute

boolean

default:false

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_id

string

string identifier of the tenant this broadcast is associated with

cancellation_key

string

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.

Maximum string length: 512

Example:

"booking-123"

Response

202 - Accepted

Plain-text confirmation that the broadcast request was accepted for processing.

Example:

"OK"

⌘I

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"
    }
  }'

import requests

url = "https://hub.suprsend.com/{workspace_key}/broadcast/"

payload = {
    "list_id": "_list_id_",
    "template": "_template_slug_",
    "notification_category": "transactional",
    "channels": ["<string>"],
    "data": {},
    "delay": "<string>",
    "trigger_at": "2023-11-07T05:31:56Z",
    "precompute": False,
    "tenant_id": "<string>",
    "cancellation_key": "booking-123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    list_id: '_list_id_',
    template: '_template_slug_',
    notification_category: 'transactional',
    channels: ['<string>'],
    data: {},
    delay: '<string>',
    trigger_at: '2023-11-07T05:31:56Z',
    precompute: false,
    tenant_id: '<string>',
    cancellation_key: 'booking-123'
  })
};

fetch('https://hub.suprsend.com/{workspace_key}/broadcast/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://hub.suprsend.com/{workspace_key}/broadcast/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'list_id' => '_list_id_',
    'template' => '_template_slug_',
    'notification_category' => 'transactional',
    'channels' => [
        '<string>'
    ],
    'data' => [
        
    ],
    'delay' => '<string>',
    'trigger_at' => '2023-11-07T05:31:56Z',
    'precompute' => false,
    'tenant_id' => '<string>',
    'cancellation_key' => 'booking-123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://hub.suprsend.com/{workspace_key}/broadcast/"

	payload := strings.NewReader("{\n  \"list_id\": \"_list_id_\",\n  \"template\": \"_template_slug_\",\n  \"notification_category\": \"transactional\",\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"data\": {},\n  \"delay\": \"<string>\",\n  \"trigger_at\": \"2023-11-07T05:31:56Z\",\n  \"precompute\": false,\n  \"tenant_id\": \"<string>\",\n  \"cancellation_key\": \"booking-123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://hub.suprsend.com/{workspace_key}/broadcast/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"list_id\": \"_list_id_\",\n  \"template\": \"_template_slug_\",\n  \"notification_category\": \"transactional\",\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"data\": {},\n  \"delay\": \"<string>\",\n  \"trigger_at\": \"2023-11-07T05:31:56Z\",\n  \"precompute\": false,\n  \"tenant_id\": \"<string>\",\n  \"cancellation_key\": \"booking-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://hub.suprsend.com/{workspace_key}/broadcast/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"list_id\": \"_list_id_\",\n  \"template\": \"_template_slug_\",\n  \"notification_category\": \"transactional\",\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"data\": {},\n  \"delay\": \"<string>\",\n  \"trigger_at\": \"2023-11-07T05:31:56Z\",\n  \"precompute\": false,\n  \"tenant_id\": \"<string>\",\n  \"cancellation_key\": \"booking-123\"\n}"

response = http.request(request)
puts response.read_body

OK

BAD REQUEST

API Reference

USERS

TRIGGER WORKFLOWS

EVENTS

MESSAGES

OBJECTS

TEMPLATES

TENANTS

PREFERENCE

LISTS

BROADCAST

Authorizations

Path Parameters

Body

Response