Create broadcast
curl --request POST \
--url http://localhost:3001/api/v1/broadcasts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"segmentKey": "<string>",
"from": "<string>",
"subject": "<string>",
"replyTo": "jsmith@example.com",
"html": "<string>",
"text": "<string>",
"name": "<string>",
"topicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateKey": "<string>",
"send": false,
"scheduledAt": "<string>"
}
'import requests
url = "http://localhost:3001/api/v1/broadcasts"
payload = {
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"segmentKey": "<string>",
"from": "<string>",
"subject": "<string>",
"replyTo": "jsmith@example.com",
"html": "<string>",
"text": "<string>",
"name": "<string>",
"topicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateKey": "<string>",
"send": False,
"scheduledAt": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
segmentKey: '<string>',
from: '<string>',
subject: '<string>',
replyTo: 'jsmith@example.com',
html: '<string>',
text: '<string>',
name: '<string>',
topicId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subscriptionGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
templateKey: '<string>',
send: false,
scheduledAt: '<string>'
})
};
fetch('http://localhost:3001/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_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/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([
'segmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'segmentKey' => '<string>',
'from' => '<string>',
'subject' => '<string>',
'replyTo' => 'jsmith@example.com',
'html' => '<string>',
'text' => '<string>',
'name' => '<string>',
'topicId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subscriptionGroupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'templateKey' => '<string>',
'send' => false,
'scheduledAt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:3001/api/v1/broadcasts"
payload := strings.NewReader("{\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"segmentKey\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"html\": \"<string>\",\n \"text\": \"<string>\",\n \"name\": \"<string>\",\n \"topicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subscriptionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateKey\": \"<string>\",\n \"send\": false,\n \"scheduledAt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:3001/api/v1/broadcasts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"segmentKey\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"html\": \"<string>\",\n \"text\": \"<string>\",\n \"name\": \"<string>\",\n \"topicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subscriptionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateKey\": \"<string>\",\n \"send\": false,\n \"scheduledAt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/broadcasts")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"segmentKey\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"html\": \"<string>\",\n \"text\": \"<string>\",\n \"name\": \"<string>\",\n \"topicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subscriptionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateKey\": \"<string>\",\n \"send\": false,\n \"scheduledAt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Broadcasts
Create broadcast
Create a Broadcast for a Segment. Inline content creates a saved Email Template first; templateId reuses an existing Template. Set send=true to send immediately, or combine send=true with scheduledAt to schedule.
POST
/
api
/
v1
/
broadcasts
Create broadcast
curl --request POST \
--url http://localhost:3001/api/v1/broadcasts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"segmentKey": "<string>",
"from": "<string>",
"subject": "<string>",
"replyTo": "jsmith@example.com",
"html": "<string>",
"text": "<string>",
"name": "<string>",
"topicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateKey": "<string>",
"send": false,
"scheduledAt": "<string>"
}
'import requests
url = "http://localhost:3001/api/v1/broadcasts"
payload = {
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"segmentKey": "<string>",
"from": "<string>",
"subject": "<string>",
"replyTo": "jsmith@example.com",
"html": "<string>",
"text": "<string>",
"name": "<string>",
"topicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateKey": "<string>",
"send": False,
"scheduledAt": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
segmentKey: '<string>',
from: '<string>',
subject: '<string>',
replyTo: 'jsmith@example.com',
html: '<string>',
text: '<string>',
name: '<string>',
topicId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subscriptionGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
templateKey: '<string>',
send: false,
scheduledAt: '<string>'
})
};
fetch('http://localhost:3001/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_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/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([
'segmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'segmentKey' => '<string>',
'from' => '<string>',
'subject' => '<string>',
'replyTo' => 'jsmith@example.com',
'html' => '<string>',
'text' => '<string>',
'name' => '<string>',
'topicId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subscriptionGroupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'templateKey' => '<string>',
'send' => false,
'scheduledAt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:3001/api/v1/broadcasts"
payload := strings.NewReader("{\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"segmentKey\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"html\": \"<string>\",\n \"text\": \"<string>\",\n \"name\": \"<string>\",\n \"topicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subscriptionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateKey\": \"<string>\",\n \"send\": false,\n \"scheduledAt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:3001/api/v1/broadcasts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"segmentKey\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"html\": \"<string>\",\n \"text\": \"<string>\",\n \"name\": \"<string>\",\n \"topicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subscriptionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateKey\": \"<string>\",\n \"send\": false,\n \"scheduledAt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/broadcasts")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"segmentKey\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"html\": \"<string>\",\n \"text\": \"<string>\",\n \"name\": \"<string>\",\n \"topicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subscriptionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateKey\": \"<string>\",\n \"send\": false,\n \"scheduledAt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Authorizations
Unified API key for server-side SDK and API integrations
Body
application/json
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required string length:
1 - 120Sender email address. Friendly names may use "Name sender@example.com".
Required string length:
1 - 320Required string length:
1 - 998Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Minimum string length:
1Required string length:
1 - 200Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required string length:
1 - 120Minimum string length:
1Response
Default Response
Broadcast id.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$⌘I

