Broadcasts
Create broadcast
Starts a broadcast as a draft or scheduled send for the supplied audience. Use broadcasts.list to avoid duplicates, then use broadcasts.schedule to control its send time.
POST
/
v1
/
broadcasts
Create broadcast
curl --request POST \
--url https://app.chatbotx.io/api/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schedulesAt": "<string>",
"contactFilter": {
"conditions": [
{
"field": "locale",
"value": "<string>"
}
],
"timezone": "<string>"
},
"flowId": "<string>",
"templateId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<string>"
}
]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [
{}
],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<unknown>"
}
]
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
],
"targets": [
{
"inboxId": "<string>",
"flowId": "<string>",
"templateId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<unknown>"
}
]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [
{}
],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<unknown>",
"paramLabel": "<unknown>",
"customFieldId": "<unknown>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<unknown>",
"product_items": "<unknown>"
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
]
}
],
"inboxIds": [
"<string>"
],
"saveAsDraft": true
}
'import requests
url = "https://app.chatbotx.io/api/v1/broadcasts"
payload = {
"schedulesAt": "<string>",
"contactFilter": {
"conditions": [
{
"field": "locale",
"value": "<string>"
}
],
"timezone": "<string>"
},
"flowId": "<string>",
"templateId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [{ "product_retailer_id": "<string>" }]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [{}],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [{ "product_retailer_id": "<unknown>" }]
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
],
"targets": [
{
"inboxId": "<string>",
"flowId": "<string>",
"templateId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [{ "product_retailer_id": "<unknown>" }]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [{}],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<unknown>",
"paramLabel": "<unknown>",
"customFieldId": "<unknown>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<unknown>",
"product_items": "<unknown>"
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
]
}
],
"inboxIds": ["<string>"],
"saveAsDraft": True
}
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({
schedulesAt: '<string>',
contactFilter: {conditions: [{field: 'locale', value: '<string>'}], timezone: '<string>'},
flowId: '<string>',
templateId: '<string>',
integrationWhatsappId: '<string>',
integrationMessengerId: '<string>',
templateData: {
header: [
{
text: '<string>',
parameter_name: '<string>',
location: {
latitude: '<string>',
longitude: '<string>',
name: '<string>',
address: '<string>'
}
}
],
body: JSON.stringify([{text: '<string>', type: 'text', parameter_name: '<string>'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<string>', customFieldId: '<string>', paramLabel: '<string>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<string>', product_items: [{product_retailer_id: '<string>'}]}]
}
],
carousel: [
{
card_index: 123,
header: [{}],
body: JSON.stringify([{text: '<string>', type: 'text'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<string>', customFieldId: '<string>', paramLabel: '<string>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<string>', product_items: [{product_retailer_id: '<unknown>'}]}]
}
]
}
]
},
buttons: [{id: '<string>', label: '<string>', flowId: '<string>'}],
targets: [
{
inboxId: '<string>',
flowId: '<string>',
templateId: '<string>',
templateData: {
header: [
{
text: '<string>',
parameter_name: '<string>',
location: {
latitude: '<string>',
longitude: '<string>',
name: '<string>',
address: '<string>'
}
}
],
body: JSON.stringify([{text: '<string>', type: 'text', parameter_name: '<string>'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<string>', customFieldId: '<string>', paramLabel: '<string>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<string>', product_items: [{product_retailer_id: '<unknown>'}]}]
}
],
carousel: [
{
card_index: 123,
header: [{}],
body: JSON.stringify([{text: '<string>', type: 'text'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<unknown>', paramLabel: '<unknown>', customFieldId: '<unknown>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<unknown>', product_items: '<unknown>'}]
}
]
}
]
},
buttons: [{id: '<string>', label: '<string>', flowId: '<string>'}]
}
],
inboxIds: ['<string>'],
saveAsDraft: true
})
};
fetch('https://app.chatbotx.io/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://app.chatbotx.io/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([
'schedulesAt' => '<string>',
'contactFilter' => [
'conditions' => [
[
'field' => 'locale',
'value' => '<string>'
]
],
'timezone' => '<string>'
],
'flowId' => '<string>',
'templateId' => '<string>',
'integrationWhatsappId' => '<string>',
'integrationMessengerId' => '<string>',
'templateData' => [
'header' => [
[
'text' => '<string>',
'parameter_name' => '<string>',
'location' => [
'latitude' => '<string>',
'longitude' => '<string>',
'name' => '<string>',
'address' => '<string>'
]
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text',
'parameter_name' => '<string>'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<string>',
'customFieldId' => '<string>',
'paramLabel' => '<string>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_items' => [
[
'product_retailer_id' => '<string>'
]
]
]
]
]
],
'carousel' => [
[
'card_index' => 123,
'header' => [
[
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<string>',
'customFieldId' => '<string>',
'paramLabel' => '<string>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_items' => [
[
'product_retailer_id' => '<unknown>'
]
]
]
]
]
]
]
]
],
'buttons' => [
[
'id' => '<string>',
'label' => '<string>',
'flowId' => '<string>'
]
],
'targets' => [
[
'inboxId' => '<string>',
'flowId' => '<string>',
'templateId' => '<string>',
'templateData' => [
'header' => [
[
'text' => '<string>',
'parameter_name' => '<string>',
'location' => [
'latitude' => '<string>',
'longitude' => '<string>',
'name' => '<string>',
'address' => '<string>'
]
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text',
'parameter_name' => '<string>'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<string>',
'customFieldId' => '<string>',
'paramLabel' => '<string>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_items' => [
[
'product_retailer_id' => '<unknown>'
]
]
]
]
]
],
'carousel' => [
[
'card_index' => 123,
'header' => [
[
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<unknown>',
'paramLabel' => '<unknown>',
'customFieldId' => '<unknown>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<unknown>',
'product_items' => '<unknown>'
]
]
]
]
]
]
],
'buttons' => [
[
'id' => '<string>',
'label' => '<string>',
'flowId' => '<string>'
]
]
]
],
'inboxIds' => [
'<string>'
],
'saveAsDraft' => true
]),
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://app.chatbotx.io/api/v1/broadcasts"
payload := strings.NewReader("{\n \"schedulesAt\": \"<string>\",\n \"contactFilter\": {\n \"conditions\": [\n {\n \"field\": \"locale\",\n \"value\": \"<string>\"\n }\n ],\n \"timezone\": \"<string>\"\n },\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ],\n \"targets\": [\n {\n \"inboxId\": \"<string>\",\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<unknown>\",\n \"paramLabel\": \"<unknown>\",\n \"customFieldId\": \"<unknown>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<unknown>\",\n \"product_items\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ]\n }\n ],\n \"inboxIds\": [\n \"<string>\"\n ],\n \"saveAsDraft\": true\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://app.chatbotx.io/api/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schedulesAt\": \"<string>\",\n \"contactFilter\": {\n \"conditions\": [\n {\n \"field\": \"locale\",\n \"value\": \"<string>\"\n }\n ],\n \"timezone\": \"<string>\"\n },\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ],\n \"targets\": [\n {\n \"inboxId\": \"<string>\",\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<unknown>\",\n \"paramLabel\": \"<unknown>\",\n \"customFieldId\": \"<unknown>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<unknown>\",\n \"product_items\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ]\n }\n ],\n \"inboxIds\": [\n \"<string>\"\n ],\n \"saveAsDraft\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/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 \"schedulesAt\": \"<string>\",\n \"contactFilter\": {\n \"conditions\": [\n {\n \"field\": \"locale\",\n \"value\": \"<string>\"\n }\n ],\n \"timezone\": \"<string>\"\n },\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ],\n \"targets\": [\n {\n \"inboxId\": \"<string>\",\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<unknown>\",\n \"paramLabel\": \"<unknown>\",\n \"customFieldId\": \"<unknown>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<unknown>\",\n \"product_items\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ]\n }\n ],\n \"inboxIds\": [\n \"<string>\"\n ],\n \"saveAsDraft\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"status": "scheduled",
"schedulesType": "now",
"schedulesAt": "2023-11-07T05:31:56Z",
"contactCount": -1,
"id": "<unknown>",
"flowId": null
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}Authorizations
bearerAuthdeveloperAccessTokentokenInSearchParams
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Channel to send the broadcast over.
Available options:
omnichannel, webchat, messenger, whatsapp, zalo, smtp, telegram, instagram, threads, tiktok, api Audience sub-action filter.
Available options:
allContacts, messengerActiveContacts, messengerTemplateMessage, whatsappTemplateMessage, whatsappWithin24Hours, instagramActiveContacts, telegramAllContacts, tiktokActiveContacts When to send: immediately (now) or at schedulesAt (future).
Available options:
now, future ISO 8601 send time, required when schedulesType is future and not a draft.
Structured filter selecting the recipient audience. See contacts.listFilterFields.
Show child attributes
Show child attributes
Flow id (numeric string) to send. Provide this or templateId, not both.
Pattern:
^\d+$WhatsApp template id (numeric string) to send. Provide this or flowId, not both.
Pattern:
^\d+$WhatsApp integration id (numeric string) to send from.
Pattern:
^\d+$Messenger integration id (numeric string) to send from.
Pattern:
^\d+$Parameters for the WhatsApp template, when sending a single-page broadcast.
- Option 1
- Option 2
Show child attributes
Show child attributes
Button overrides for the WhatsApp template.
Show child attributes
Show child attributes
Per-page targets for a multi-page broadcast, each with its own template/flow.
Show child attributes
Show child attributes
Inbox ids (numeric strings) this broadcast sends from.
Pattern:
^\d+$Save as a draft instead of scheduling/sending immediately.
Response
OK
Available options:
scheduled, sent, sending, cancelled, draft, failed Available options:
now, future Required range:
-2147483648 <= x <= 2147483647Was this page helpful?
⌘I
Create broadcast
curl --request POST \
--url https://app.chatbotx.io/api/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schedulesAt": "<string>",
"contactFilter": {
"conditions": [
{
"field": "locale",
"value": "<string>"
}
],
"timezone": "<string>"
},
"flowId": "<string>",
"templateId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<string>"
}
]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [
{}
],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<unknown>"
}
]
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
],
"targets": [
{
"inboxId": "<string>",
"flowId": "<string>",
"templateId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<unknown>"
}
]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [
{}
],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<unknown>",
"paramLabel": "<unknown>",
"customFieldId": "<unknown>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<unknown>",
"product_items": "<unknown>"
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
]
}
],
"inboxIds": [
"<string>"
],
"saveAsDraft": true
}
'import requests
url = "https://app.chatbotx.io/api/v1/broadcasts"
payload = {
"schedulesAt": "<string>",
"contactFilter": {
"conditions": [
{
"field": "locale",
"value": "<string>"
}
],
"timezone": "<string>"
},
"flowId": "<string>",
"templateId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [{ "product_retailer_id": "<string>" }]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [{}],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [{ "product_retailer_id": "<unknown>" }]
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
],
"targets": [
{
"inboxId": "<string>",
"flowId": "<string>",
"templateId": "<string>",
"templateData": {
"header": [
{
"text": "<string>",
"parameter_name": "<string>",
"location": {
"latitude": "<string>",
"longitude": "<string>",
"name": "<string>",
"address": "<string>"
}
}
],
"body": [
{
"text": "<string>",
"type": "text",
"parameter_name": "<string>"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<string>",
"customFieldId": "<string>",
"paramLabel": "<string>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<string>",
"product_items": [{ "product_retailer_id": "<unknown>" }]
}
]
}
],
"carousel": [
{
"card_index": 123,
"header": [{}],
"body": [
{
"text": "<string>",
"type": "text"
}
],
"button": [
{
"index": 123,
"text": "<string>",
"coupon_code": "<string>",
"payload": "<string>",
"flow_token": "<string>",
"flow_action_data": {},
"flowSourceId": "<string>",
"navigateScreenId": "<string>",
"fieldMappings": [
{
"paramKey": "<unknown>",
"paramLabel": "<unknown>",
"customFieldId": "<unknown>"
}
],
"thumbnail_product_retailer_id": "<string>",
"sections": [
{
"title": "<unknown>",
"product_items": "<unknown>"
}
]
}
]
}
]
},
"buttons": [
{
"id": "<string>",
"label": "<string>",
"flowId": "<string>"
}
]
}
],
"inboxIds": ["<string>"],
"saveAsDraft": True
}
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({
schedulesAt: '<string>',
contactFilter: {conditions: [{field: 'locale', value: '<string>'}], timezone: '<string>'},
flowId: '<string>',
templateId: '<string>',
integrationWhatsappId: '<string>',
integrationMessengerId: '<string>',
templateData: {
header: [
{
text: '<string>',
parameter_name: '<string>',
location: {
latitude: '<string>',
longitude: '<string>',
name: '<string>',
address: '<string>'
}
}
],
body: JSON.stringify([{text: '<string>', type: 'text', parameter_name: '<string>'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<string>', customFieldId: '<string>', paramLabel: '<string>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<string>', product_items: [{product_retailer_id: '<string>'}]}]
}
],
carousel: [
{
card_index: 123,
header: [{}],
body: JSON.stringify([{text: '<string>', type: 'text'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<string>', customFieldId: '<string>', paramLabel: '<string>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<string>', product_items: [{product_retailer_id: '<unknown>'}]}]
}
]
}
]
},
buttons: [{id: '<string>', label: '<string>', flowId: '<string>'}],
targets: [
{
inboxId: '<string>',
flowId: '<string>',
templateId: '<string>',
templateData: {
header: [
{
text: '<string>',
parameter_name: '<string>',
location: {
latitude: '<string>',
longitude: '<string>',
name: '<string>',
address: '<string>'
}
}
],
body: JSON.stringify([{text: '<string>', type: 'text', parameter_name: '<string>'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<string>', customFieldId: '<string>', paramLabel: '<string>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<string>', product_items: [{product_retailer_id: '<unknown>'}]}]
}
],
carousel: [
{
card_index: 123,
header: [{}],
body: JSON.stringify([{text: '<string>', type: 'text'}]),
button: [
{
index: 123,
text: '<string>',
coupon_code: '<string>',
payload: '<string>',
flow_token: '<string>',
flow_action_data: {},
flowSourceId: '<string>',
navigateScreenId: '<string>',
fieldMappings: [{paramKey: '<unknown>', paramLabel: '<unknown>', customFieldId: '<unknown>'}],
thumbnail_product_retailer_id: '<string>',
sections: [{title: '<unknown>', product_items: '<unknown>'}]
}
]
}
]
},
buttons: [{id: '<string>', label: '<string>', flowId: '<string>'}]
}
],
inboxIds: ['<string>'],
saveAsDraft: true
})
};
fetch('https://app.chatbotx.io/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://app.chatbotx.io/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([
'schedulesAt' => '<string>',
'contactFilter' => [
'conditions' => [
[
'field' => 'locale',
'value' => '<string>'
]
],
'timezone' => '<string>'
],
'flowId' => '<string>',
'templateId' => '<string>',
'integrationWhatsappId' => '<string>',
'integrationMessengerId' => '<string>',
'templateData' => [
'header' => [
[
'text' => '<string>',
'parameter_name' => '<string>',
'location' => [
'latitude' => '<string>',
'longitude' => '<string>',
'name' => '<string>',
'address' => '<string>'
]
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text',
'parameter_name' => '<string>'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<string>',
'customFieldId' => '<string>',
'paramLabel' => '<string>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_items' => [
[
'product_retailer_id' => '<string>'
]
]
]
]
]
],
'carousel' => [
[
'card_index' => 123,
'header' => [
[
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<string>',
'customFieldId' => '<string>',
'paramLabel' => '<string>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_items' => [
[
'product_retailer_id' => '<unknown>'
]
]
]
]
]
]
]
]
],
'buttons' => [
[
'id' => '<string>',
'label' => '<string>',
'flowId' => '<string>'
]
],
'targets' => [
[
'inboxId' => '<string>',
'flowId' => '<string>',
'templateId' => '<string>',
'templateData' => [
'header' => [
[
'text' => '<string>',
'parameter_name' => '<string>',
'location' => [
'latitude' => '<string>',
'longitude' => '<string>',
'name' => '<string>',
'address' => '<string>'
]
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text',
'parameter_name' => '<string>'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<string>',
'customFieldId' => '<string>',
'paramLabel' => '<string>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_items' => [
[
'product_retailer_id' => '<unknown>'
]
]
]
]
]
],
'carousel' => [
[
'card_index' => 123,
'header' => [
[
]
],
'body' => [
[
'text' => '<string>',
'type' => 'text'
]
],
'button' => [
[
'index' => 123,
'text' => '<string>',
'coupon_code' => '<string>',
'payload' => '<string>',
'flow_token' => '<string>',
'flow_action_data' => [
],
'flowSourceId' => '<string>',
'navigateScreenId' => '<string>',
'fieldMappings' => [
[
'paramKey' => '<unknown>',
'paramLabel' => '<unknown>',
'customFieldId' => '<unknown>'
]
],
'thumbnail_product_retailer_id' => '<string>',
'sections' => [
[
'title' => '<unknown>',
'product_items' => '<unknown>'
]
]
]
]
]
]
],
'buttons' => [
[
'id' => '<string>',
'label' => '<string>',
'flowId' => '<string>'
]
]
]
],
'inboxIds' => [
'<string>'
],
'saveAsDraft' => true
]),
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://app.chatbotx.io/api/v1/broadcasts"
payload := strings.NewReader("{\n \"schedulesAt\": \"<string>\",\n \"contactFilter\": {\n \"conditions\": [\n {\n \"field\": \"locale\",\n \"value\": \"<string>\"\n }\n ],\n \"timezone\": \"<string>\"\n },\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ],\n \"targets\": [\n {\n \"inboxId\": \"<string>\",\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<unknown>\",\n \"paramLabel\": \"<unknown>\",\n \"customFieldId\": \"<unknown>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<unknown>\",\n \"product_items\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ]\n }\n ],\n \"inboxIds\": [\n \"<string>\"\n ],\n \"saveAsDraft\": true\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://app.chatbotx.io/api/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schedulesAt\": \"<string>\",\n \"contactFilter\": {\n \"conditions\": [\n {\n \"field\": \"locale\",\n \"value\": \"<string>\"\n }\n ],\n \"timezone\": \"<string>\"\n },\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ],\n \"targets\": [\n {\n \"inboxId\": \"<string>\",\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<unknown>\",\n \"paramLabel\": \"<unknown>\",\n \"customFieldId\": \"<unknown>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<unknown>\",\n \"product_items\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ]\n }\n ],\n \"inboxIds\": [\n \"<string>\"\n ],\n \"saveAsDraft\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/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 \"schedulesAt\": \"<string>\",\n \"contactFilter\": {\n \"conditions\": [\n {\n \"field\": \"locale\",\n \"value\": \"<string>\"\n }\n ],\n \"timezone\": \"<string>\"\n },\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ],\n \"targets\": [\n {\n \"inboxId\": \"<string>\",\n \"flowId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateData\": {\n \"header\": [\n {\n \"text\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"location\": {\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n }\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\",\n \"parameter_name\": \"<string>\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"paramLabel\": \"<string>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ],\n \"carousel\": [\n {\n \"card_index\": 123,\n \"header\": [\n {}\n ],\n \"body\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ],\n \"button\": [\n {\n \"index\": 123,\n \"text\": \"<string>\",\n \"coupon_code\": \"<string>\",\n \"payload\": \"<string>\",\n \"flow_token\": \"<string>\",\n \"flow_action_data\": {},\n \"flowSourceId\": \"<string>\",\n \"navigateScreenId\": \"<string>\",\n \"fieldMappings\": [\n {\n \"paramKey\": \"<unknown>\",\n \"paramLabel\": \"<unknown>\",\n \"customFieldId\": \"<unknown>\"\n }\n ],\n \"thumbnail_product_retailer_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<unknown>\",\n \"product_items\": \"<unknown>\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"flowId\": \"<string>\"\n }\n ]\n }\n ],\n \"inboxIds\": [\n \"<string>\"\n ],\n \"saveAsDraft\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"status": "scheduled",
"schedulesType": "now",
"schedulesAt": "2023-11-07T05:31:56Z",
"contactCount": -1,
"id": "<unknown>",
"flowId": null
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}