Send a broadcast
curl --request POST \
--url https://api.example.com/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"tagIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stageIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"assigneeIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"includeUnassigned": true,
"channelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"createdAfter": "2023-11-07T05:31:56Z",
"createdBefore": "2023-11-07T05:31:56Z",
"lastUpdatedAfter": "2023-11-07T05:31:56Z",
"lastUpdatedBefore": "2023-11-07T05:31:56Z",
"lastInteractionAfter": "2023-11-07T05:31:56Z",
"lastInteractionBefore": "2023-11-07T05:31:56Z",
"phoneFilters": [
{
"countryCode": "<string>",
"prefix": "<string>"
}
],
"adIds": [
"<string>"
],
"campaignIds": [
"<string>"
],
"adSetIds": [
"<string>"
],
"adUrls": [
"<string>"
],
"hasConversations": true,
"sourceMethods": [],
"broadcastIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"isBlocked": true,
"countries": [
"<string>"
],
"customFieldFilters": [
{
"fieldKey": "<string>",
"values": [
"<string>"
]
}
]
},
"channelId": "<string>",
"name": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"removedContactIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"addedContactIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"templateId": "<string>",
"quickReplyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowMultiDaySend": true,
"headerMediaKey": "<string>",
"templateBodyParameters": [
"<string>"
],
"templateHeaderTextParameter": "<string>",
"templateUrlButtonParameters": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/broadcasts"
payload = {
"filters": {
"tagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"stageIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"assigneeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"includeUnassigned": True,
"channelIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"createdAfter": "2023-11-07T05:31:56Z",
"createdBefore": "2023-11-07T05:31:56Z",
"lastUpdatedAfter": "2023-11-07T05:31:56Z",
"lastUpdatedBefore": "2023-11-07T05:31:56Z",
"lastInteractionAfter": "2023-11-07T05:31:56Z",
"lastInteractionBefore": "2023-11-07T05:31:56Z",
"phoneFilters": [
{
"countryCode": "<string>",
"prefix": "<string>"
}
],
"adIds": ["<string>"],
"campaignIds": ["<string>"],
"adSetIds": ["<string>"],
"adUrls": ["<string>"],
"hasConversations": True,
"sourceMethods": [],
"broadcastIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"isBlocked": True,
"countries": ["<string>"],
"customFieldFilters": [
{
"fieldKey": "<string>",
"values": ["<string>"]
}
]
},
"channelId": "<string>",
"name": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"removedContactIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"addedContactIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"templateId": "<string>",
"quickReplyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowMultiDaySend": True,
"headerMediaKey": "<string>",
"templateBodyParameters": ["<string>"],
"templateHeaderTextParameter": "<string>",
"templateUrlButtonParameters": ["<string>"]
}
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({
filters: {
tagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
stageIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
assigneeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
includeUnassigned: true,
channelIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
createdAfter: '2023-11-07T05:31:56Z',
createdBefore: '2023-11-07T05:31:56Z',
lastUpdatedAfter: '2023-11-07T05:31:56Z',
lastUpdatedBefore: '2023-11-07T05:31:56Z',
lastInteractionAfter: '2023-11-07T05:31:56Z',
lastInteractionBefore: '2023-11-07T05:31:56Z',
phoneFilters: [{countryCode: '<string>', prefix: '<string>'}],
adIds: ['<string>'],
campaignIds: ['<string>'],
adSetIds: ['<string>'],
adUrls: ['<string>'],
hasConversations: true,
sourceMethods: [],
broadcastIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
isBlocked: true,
countries: ['<string>'],
customFieldFilters: [{fieldKey: '<string>', values: ['<string>']}]
},
channelId: '<string>',
name: '<string>',
segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
removedContactIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
addedContactIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
templateId: '<string>',
quickReplyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
allowMultiDaySend: true,
headerMediaKey: '<string>',
templateBodyParameters: ['<string>'],
templateHeaderTextParameter: '<string>',
templateUrlButtonParameters: ['<string>']
})
};
fetch('https://api.example.com/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://api.example.com/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([
'filters' => [
'tagIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'stageIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'assigneeIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'includeUnassigned' => true,
'channelIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'createdAfter' => '2023-11-07T05:31:56Z',
'createdBefore' => '2023-11-07T05:31:56Z',
'lastUpdatedAfter' => '2023-11-07T05:31:56Z',
'lastUpdatedBefore' => '2023-11-07T05:31:56Z',
'lastInteractionAfter' => '2023-11-07T05:31:56Z',
'lastInteractionBefore' => '2023-11-07T05:31:56Z',
'phoneFilters' => [
[
'countryCode' => '<string>',
'prefix' => '<string>'
]
],
'adIds' => [
'<string>'
],
'campaignIds' => [
'<string>'
],
'adSetIds' => [
'<string>'
],
'adUrls' => [
'<string>'
],
'hasConversations' => true,
'sourceMethods' => [
],
'broadcastIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'isBlocked' => true,
'countries' => [
'<string>'
],
'customFieldFilters' => [
[
'fieldKey' => '<string>',
'values' => [
'<string>'
]
]
]
],
'channelId' => '<string>',
'name' => '<string>',
'segmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'removedContactIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'addedContactIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'templateId' => '<string>',
'quickReplyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'allowMultiDaySend' => true,
'headerMediaKey' => '<string>',
'templateBodyParameters' => [
'<string>'
],
'templateHeaderTextParameter' => '<string>',
'templateUrlButtonParameters' => [
'<string>'
]
]),
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://api.example.com/v1/broadcasts"
payload := strings.NewReader("{\n \"filters\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stageIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assigneeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"includeUnassigned\": true,\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"createdAfter\": \"2023-11-07T05:31:56Z\",\n \"createdBefore\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedAfter\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedBefore\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionAfter\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionBefore\": \"2023-11-07T05:31:56Z\",\n \"phoneFilters\": [\n {\n \"countryCode\": \"<string>\",\n \"prefix\": \"<string>\"\n }\n ],\n \"adIds\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n \"<string>\"\n ],\n \"adSetIds\": [\n \"<string>\"\n ],\n \"adUrls\": [\n \"<string>\"\n ],\n \"hasConversations\": true,\n \"sourceMethods\": [],\n \"broadcastIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"isBlocked\": true,\n \"countries\": [\n \"<string>\"\n ],\n \"customFieldFilters\": [\n {\n \"fieldKey\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"channelId\": \"<string>\",\n \"name\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"removedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"addedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"templateId\": \"<string>\",\n \"quickReplyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"allowMultiDaySend\": true,\n \"headerMediaKey\": \"<string>\",\n \"templateBodyParameters\": [\n \"<string>\"\n ],\n \"templateHeaderTextParameter\": \"<string>\",\n \"templateUrlButtonParameters\": [\n \"<string>\"\n ]\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://api.example.com/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stageIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assigneeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"includeUnassigned\": true,\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"createdAfter\": \"2023-11-07T05:31:56Z\",\n \"createdBefore\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedAfter\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedBefore\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionAfter\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionBefore\": \"2023-11-07T05:31:56Z\",\n \"phoneFilters\": [\n {\n \"countryCode\": \"<string>\",\n \"prefix\": \"<string>\"\n }\n ],\n \"adIds\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n \"<string>\"\n ],\n \"adSetIds\": [\n \"<string>\"\n ],\n \"adUrls\": [\n \"<string>\"\n ],\n \"hasConversations\": true,\n \"sourceMethods\": [],\n \"broadcastIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"isBlocked\": true,\n \"countries\": [\n \"<string>\"\n ],\n \"customFieldFilters\": [\n {\n \"fieldKey\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"channelId\": \"<string>\",\n \"name\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"removedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"addedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"templateId\": \"<string>\",\n \"quickReplyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"allowMultiDaySend\": true,\n \"headerMediaKey\": \"<string>\",\n \"templateBodyParameters\": [\n \"<string>\"\n ],\n \"templateHeaderTextParameter\": \"<string>\",\n \"templateUrlButtonParameters\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/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 \"filters\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stageIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assigneeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"includeUnassigned\": true,\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"createdAfter\": \"2023-11-07T05:31:56Z\",\n \"createdBefore\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedAfter\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedBefore\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionAfter\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionBefore\": \"2023-11-07T05:31:56Z\",\n \"phoneFilters\": [\n {\n \"countryCode\": \"<string>\",\n \"prefix\": \"<string>\"\n }\n ],\n \"adIds\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n \"<string>\"\n ],\n \"adSetIds\": [\n \"<string>\"\n ],\n \"adUrls\": [\n \"<string>\"\n ],\n \"hasConversations\": true,\n \"sourceMethods\": [],\n \"broadcastIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"isBlocked\": true,\n \"countries\": [\n \"<string>\"\n ],\n \"customFieldFilters\": [\n {\n \"fieldKey\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"channelId\": \"<string>\",\n \"name\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"removedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"addedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"templateId\": \"<string>\",\n \"quickReplyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"allowMultiDaySend\": true,\n \"headerMediaKey\": \"<string>\",\n \"templateBodyParameters\": [\n \"<string>\"\n ],\n \"templateHeaderTextParameter\": \"<string>\",\n \"templateUrlButtonParameters\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Broadcasts
Send a broadcast
Sends a message to an audience: either a saved segment on its own, or a set of filters plus up to 500 hand-picked contact ids. The two shapes never mix, and a body naming nobody is rejected.
The message is a WhatsApp template (templateId), a quick reply (quickReplyId, from GET /v1/quick-replies), or both — at least one is required:
- Template only — sent to every recipient.
- Quick reply and template — a recipient whose 24-hour customer service window is open (or who is inside a 72-hour Free Entry Point window) gets the quick reply as an ordinary message; everyone else gets the template.
- Quick reply only — WhatsApp delivers a non-template message only inside an open window. A recipient whose window is closed fails (failure code 131047), and a recipient who has never had a conversation on the channel is skipped (
skippedNoConversationCount).
Template parameters (headerMediaKey, templateBodyParameters, …) are only accepted with a templateId.
POST
/
v1
/
broadcasts
Send a broadcast
curl --request POST \
--url https://api.example.com/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"tagIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stageIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"assigneeIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"includeUnassigned": true,
"channelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"createdAfter": "2023-11-07T05:31:56Z",
"createdBefore": "2023-11-07T05:31:56Z",
"lastUpdatedAfter": "2023-11-07T05:31:56Z",
"lastUpdatedBefore": "2023-11-07T05:31:56Z",
"lastInteractionAfter": "2023-11-07T05:31:56Z",
"lastInteractionBefore": "2023-11-07T05:31:56Z",
"phoneFilters": [
{
"countryCode": "<string>",
"prefix": "<string>"
}
],
"adIds": [
"<string>"
],
"campaignIds": [
"<string>"
],
"adSetIds": [
"<string>"
],
"adUrls": [
"<string>"
],
"hasConversations": true,
"sourceMethods": [],
"broadcastIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"isBlocked": true,
"countries": [
"<string>"
],
"customFieldFilters": [
{
"fieldKey": "<string>",
"values": [
"<string>"
]
}
]
},
"channelId": "<string>",
"name": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"removedContactIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"addedContactIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"templateId": "<string>",
"quickReplyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowMultiDaySend": true,
"headerMediaKey": "<string>",
"templateBodyParameters": [
"<string>"
],
"templateHeaderTextParameter": "<string>",
"templateUrlButtonParameters": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/broadcasts"
payload = {
"filters": {
"tagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"stageIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"assigneeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"includeUnassigned": True,
"channelIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"createdAfter": "2023-11-07T05:31:56Z",
"createdBefore": "2023-11-07T05:31:56Z",
"lastUpdatedAfter": "2023-11-07T05:31:56Z",
"lastUpdatedBefore": "2023-11-07T05:31:56Z",
"lastInteractionAfter": "2023-11-07T05:31:56Z",
"lastInteractionBefore": "2023-11-07T05:31:56Z",
"phoneFilters": [
{
"countryCode": "<string>",
"prefix": "<string>"
}
],
"adIds": ["<string>"],
"campaignIds": ["<string>"],
"adSetIds": ["<string>"],
"adUrls": ["<string>"],
"hasConversations": True,
"sourceMethods": [],
"broadcastIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"isBlocked": True,
"countries": ["<string>"],
"customFieldFilters": [
{
"fieldKey": "<string>",
"values": ["<string>"]
}
]
},
"channelId": "<string>",
"name": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"removedContactIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"addedContactIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"templateId": "<string>",
"quickReplyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowMultiDaySend": True,
"headerMediaKey": "<string>",
"templateBodyParameters": ["<string>"],
"templateHeaderTextParameter": "<string>",
"templateUrlButtonParameters": ["<string>"]
}
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({
filters: {
tagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
stageIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
assigneeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
includeUnassigned: true,
channelIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
createdAfter: '2023-11-07T05:31:56Z',
createdBefore: '2023-11-07T05:31:56Z',
lastUpdatedAfter: '2023-11-07T05:31:56Z',
lastUpdatedBefore: '2023-11-07T05:31:56Z',
lastInteractionAfter: '2023-11-07T05:31:56Z',
lastInteractionBefore: '2023-11-07T05:31:56Z',
phoneFilters: [{countryCode: '<string>', prefix: '<string>'}],
adIds: ['<string>'],
campaignIds: ['<string>'],
adSetIds: ['<string>'],
adUrls: ['<string>'],
hasConversations: true,
sourceMethods: [],
broadcastIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
isBlocked: true,
countries: ['<string>'],
customFieldFilters: [{fieldKey: '<string>', values: ['<string>']}]
},
channelId: '<string>',
name: '<string>',
segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
removedContactIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
addedContactIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
templateId: '<string>',
quickReplyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
allowMultiDaySend: true,
headerMediaKey: '<string>',
templateBodyParameters: ['<string>'],
templateHeaderTextParameter: '<string>',
templateUrlButtonParameters: ['<string>']
})
};
fetch('https://api.example.com/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://api.example.com/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([
'filters' => [
'tagIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'stageIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'assigneeIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'includeUnassigned' => true,
'channelIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'createdAfter' => '2023-11-07T05:31:56Z',
'createdBefore' => '2023-11-07T05:31:56Z',
'lastUpdatedAfter' => '2023-11-07T05:31:56Z',
'lastUpdatedBefore' => '2023-11-07T05:31:56Z',
'lastInteractionAfter' => '2023-11-07T05:31:56Z',
'lastInteractionBefore' => '2023-11-07T05:31:56Z',
'phoneFilters' => [
[
'countryCode' => '<string>',
'prefix' => '<string>'
]
],
'adIds' => [
'<string>'
],
'campaignIds' => [
'<string>'
],
'adSetIds' => [
'<string>'
],
'adUrls' => [
'<string>'
],
'hasConversations' => true,
'sourceMethods' => [
],
'broadcastIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'isBlocked' => true,
'countries' => [
'<string>'
],
'customFieldFilters' => [
[
'fieldKey' => '<string>',
'values' => [
'<string>'
]
]
]
],
'channelId' => '<string>',
'name' => '<string>',
'segmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'removedContactIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'addedContactIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'templateId' => '<string>',
'quickReplyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'allowMultiDaySend' => true,
'headerMediaKey' => '<string>',
'templateBodyParameters' => [
'<string>'
],
'templateHeaderTextParameter' => '<string>',
'templateUrlButtonParameters' => [
'<string>'
]
]),
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://api.example.com/v1/broadcasts"
payload := strings.NewReader("{\n \"filters\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stageIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assigneeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"includeUnassigned\": true,\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"createdAfter\": \"2023-11-07T05:31:56Z\",\n \"createdBefore\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedAfter\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedBefore\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionAfter\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionBefore\": \"2023-11-07T05:31:56Z\",\n \"phoneFilters\": [\n {\n \"countryCode\": \"<string>\",\n \"prefix\": \"<string>\"\n }\n ],\n \"adIds\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n \"<string>\"\n ],\n \"adSetIds\": [\n \"<string>\"\n ],\n \"adUrls\": [\n \"<string>\"\n ],\n \"hasConversations\": true,\n \"sourceMethods\": [],\n \"broadcastIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"isBlocked\": true,\n \"countries\": [\n \"<string>\"\n ],\n \"customFieldFilters\": [\n {\n \"fieldKey\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"channelId\": \"<string>\",\n \"name\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"removedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"addedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"templateId\": \"<string>\",\n \"quickReplyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"allowMultiDaySend\": true,\n \"headerMediaKey\": \"<string>\",\n \"templateBodyParameters\": [\n \"<string>\"\n ],\n \"templateHeaderTextParameter\": \"<string>\",\n \"templateUrlButtonParameters\": [\n \"<string>\"\n ]\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://api.example.com/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stageIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assigneeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"includeUnassigned\": true,\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"createdAfter\": \"2023-11-07T05:31:56Z\",\n \"createdBefore\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedAfter\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedBefore\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionAfter\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionBefore\": \"2023-11-07T05:31:56Z\",\n \"phoneFilters\": [\n {\n \"countryCode\": \"<string>\",\n \"prefix\": \"<string>\"\n }\n ],\n \"adIds\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n \"<string>\"\n ],\n \"adSetIds\": [\n \"<string>\"\n ],\n \"adUrls\": [\n \"<string>\"\n ],\n \"hasConversations\": true,\n \"sourceMethods\": [],\n \"broadcastIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"isBlocked\": true,\n \"countries\": [\n \"<string>\"\n ],\n \"customFieldFilters\": [\n {\n \"fieldKey\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"channelId\": \"<string>\",\n \"name\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"removedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"addedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"templateId\": \"<string>\",\n \"quickReplyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"allowMultiDaySend\": true,\n \"headerMediaKey\": \"<string>\",\n \"templateBodyParameters\": [\n \"<string>\"\n ],\n \"templateHeaderTextParameter\": \"<string>\",\n \"templateUrlButtonParameters\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/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 \"filters\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stageIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assigneeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"includeUnassigned\": true,\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"createdAfter\": \"2023-11-07T05:31:56Z\",\n \"createdBefore\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedAfter\": \"2023-11-07T05:31:56Z\",\n \"lastUpdatedBefore\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionAfter\": \"2023-11-07T05:31:56Z\",\n \"lastInteractionBefore\": \"2023-11-07T05:31:56Z\",\n \"phoneFilters\": [\n {\n \"countryCode\": \"<string>\",\n \"prefix\": \"<string>\"\n }\n ],\n \"adIds\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n \"<string>\"\n ],\n \"adSetIds\": [\n \"<string>\"\n ],\n \"adUrls\": [\n \"<string>\"\n ],\n \"hasConversations\": true,\n \"sourceMethods\": [],\n \"broadcastIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"isBlocked\": true,\n \"countries\": [\n \"<string>\"\n ],\n \"customFieldFilters\": [\n {\n \"fieldKey\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"channelId\": \"<string>\",\n \"name\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"removedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"addedContactIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"templateId\": \"<string>\",\n \"quickReplyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"allowMultiDaySend\": true,\n \"headerMediaKey\": \"<string>\",\n \"templateBodyParameters\": [\n \"<string>\"\n ],\n \"templateHeaderTextParameter\": \"<string>\",\n \"templateUrlButtonParameters\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
Your API key, e.g. flv_9f2a8c1e…
Body
application/json
Show child attributes
Show child attributes
Minimum string length:
1Required string length:
1 - 100Maximum array length:
500Maximum array length:
500Minimum string length:
1Minimum string length:
1