Create a broadcast
curl --request POST \
--url https://{domain}/api/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "March promo",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience": {
"segment": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"message": {
"type": "text",
"body": "20% off this week."
},
"schedule": true,
"scheduled_at": "2026-09-01T09:00:00Z",
"timezone_mode": "fixed",
"requires_approval": false
}
'import requests
url = "https://{domain}/api/v1/broadcasts"
payload = {
"name": "March promo",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience": { "segment": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"message": {
"type": "text",
"body": "20% off this week."
},
"schedule": True,
"scheduled_at": "2026-09-01T09:00:00Z",
"timezone_mode": "fixed",
"requires_approval": False
}
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({
name: 'March promo',
channel: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
audience: {segment: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
message: {type: 'text', body: JSON.stringify('20% off this week.')},
schedule: true,
scheduled_at: '2026-09-01T09:00:00Z',
timezone_mode: 'fixed',
requires_approval: false
})
};
fetch('https://{domain}/api/v1/broadcasts', 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://{domain}/api/v1/broadcasts",
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([
'name' => 'March promo',
'channel' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'audience' => [
'segment' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'message' => [
'type' => 'text',
'body' => '20% off this week.'
],
'schedule' => true,
'scheduled_at' => '2026-09-01T09:00:00Z',
'timezone_mode' => 'fixed',
'requires_approval' => false
]),
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://{domain}/api/v1/broadcasts"
payload := strings.NewReader("{\n \"name\": \"March promo\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"audience\": {\n \"segment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"message\": {\n \"type\": \"text\",\n \"body\": \"20% off this week.\"\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-09-01T09:00:00Z\",\n \"timezone_mode\": \"fixed\",\n \"requires_approval\": false\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://{domain}/api/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"March promo\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"audience\": {\n \"segment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"message\": {\n \"type\": \"text\",\n \"body\": \"20% off this week.\"\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-09-01T09:00:00Z\",\n \"timezone_mode\": \"fixed\",\n \"requires_approval\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v1/broadcasts")
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 \"name\": \"March promo\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"audience\": {\n \"segment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"message\": {\n \"type\": \"text\",\n \"body\": \"20% off this week.\"\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-09-01T09:00:00Z\",\n \"timezone_mode\": \"fixed\",\n \"requires_approval\": false\n}"
response = http.request(request)
puts response.read_bodyBroadcasts
Create a broadcast
Creates a campaign. Draft unless schedule is true. timezone_mode: contact sends the same wall-clock in each recipient’s own timezone and requires scheduled_local_at. Set type: retarget with source_broadcast_id + retarget_engagement to re-message a prior broadcast’s recipients instead of a segment.
Required permission: salesbot:broadcasts:write
POST
/
broadcasts
Create a broadcast
curl --request POST \
--url https://{domain}/api/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "March promo",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience": {
"segment": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"message": {
"type": "text",
"body": "20% off this week."
},
"schedule": true,
"scheduled_at": "2026-09-01T09:00:00Z",
"timezone_mode": "fixed",
"requires_approval": false
}
'import requests
url = "https://{domain}/api/v1/broadcasts"
payload = {
"name": "March promo",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience": { "segment": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"message": {
"type": "text",
"body": "20% off this week."
},
"schedule": True,
"scheduled_at": "2026-09-01T09:00:00Z",
"timezone_mode": "fixed",
"requires_approval": False
}
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({
name: 'March promo',
channel: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
audience: {segment: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
message: {type: 'text', body: JSON.stringify('20% off this week.')},
schedule: true,
scheduled_at: '2026-09-01T09:00:00Z',
timezone_mode: 'fixed',
requires_approval: false
})
};
fetch('https://{domain}/api/v1/broadcasts', 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://{domain}/api/v1/broadcasts",
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([
'name' => 'March promo',
'channel' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'audience' => [
'segment' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'message' => [
'type' => 'text',
'body' => '20% off this week.'
],
'schedule' => true,
'scheduled_at' => '2026-09-01T09:00:00Z',
'timezone_mode' => 'fixed',
'requires_approval' => false
]),
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://{domain}/api/v1/broadcasts"
payload := strings.NewReader("{\n \"name\": \"March promo\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"audience\": {\n \"segment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"message\": {\n \"type\": \"text\",\n \"body\": \"20% off this week.\"\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-09-01T09:00:00Z\",\n \"timezone_mode\": \"fixed\",\n \"requires_approval\": false\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://{domain}/api/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"March promo\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"audience\": {\n \"segment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"message\": {\n \"type\": \"text\",\n \"body\": \"20% off this week.\"\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-09-01T09:00:00Z\",\n \"timezone_mode\": \"fixed\",\n \"requires_approval\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v1/broadcasts")
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 \"name\": \"March promo\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"audience\": {\n \"segment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"message\": {\n \"type\": \"text\",\n \"body\": \"20% off this week.\"\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-09-01T09:00:00Z\",\n \"timezone_mode\": \"fixed\",\n \"requires_approval\": false\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
bearerAuthapiKeyHeader
A workspace API key: Authorization: Bearer osk_...
Body
application/json
Response
201
Created