Skip to main content
POST
/
api
/
admin
/
broadcasts
/
execute
cURL
curl --request POST \
  --url http://localhost:3001/api/admin/broadcasts/execute \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "broadcastName": "<string>",
  "segmentDefinition": {
    "entryNode": {
      "type": "Trait",
      "id": "<string>",
      "path": "<string>",
      "operator": {
        "type": "Within",
        "windowSeconds": 123
      }
    },
    "nodes": [
      {
        "type": "Trait",
        "id": "<string>",
        "path": "<string>",
        "operator": {
          "type": "Within",
          "windowSeconds": 123
        }
      }
    ]
  },
  "messageTemplateDefinition": {
    "type": "MobilePush",
    "title": "<string>",
    "body": "<string>",
    "imageUrl": "<string>"
  },
  "subscriptionGroupId": "<string>"
}
'
import requests

url = "http://localhost:3001/api/admin/broadcasts/execute"

payload = {
"workspaceId": "<string>",
"broadcastName": "<string>",
"segmentDefinition": {
"entryNode": {
"type": "Trait",
"id": "<string>",
"path": "<string>",
"operator": {
"type": "Within",
"windowSeconds": 123
}
},
"nodes": [
{
"type": "Trait",
"id": "<string>",
"path": "<string>",
"operator": {
"type": "Within",
"windowSeconds": 123
}
}
]
},
"messageTemplateDefinition": {
"type": "MobilePush",
"title": "<string>",
"body": "<string>",
"imageUrl": "<string>"
},
"subscriptionGroupId": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
broadcastName: '<string>',
segmentDefinition: {
entryNode: {
type: 'Trait',
id: '<string>',
path: '<string>',
operator: {type: 'Within', windowSeconds: 123}
},
nodes: [
{
type: 'Trait',
id: '<string>',
path: '<string>',
operator: {type: 'Within', windowSeconds: 123}
}
]
},
messageTemplateDefinition: {
type: 'MobilePush',
title: '<string>',
body: JSON.stringify('<string>'),
imageUrl: '<string>'
},
subscriptionGroupId: '<string>'
})
};

fetch('http://localhost:3001/api/admin/broadcasts/execute', 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/admin/broadcasts/execute",
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([
'workspaceId' => '<string>',
'broadcastName' => '<string>',
'segmentDefinition' => [
'entryNode' => [
'type' => 'Trait',
'id' => '<string>',
'path' => '<string>',
'operator' => [
'type' => 'Within',
'windowSeconds' => 123
]
],
'nodes' => [
[
'type' => 'Trait',
'id' => '<string>',
'path' => '<string>',
'operator' => [
'type' => 'Within',
'windowSeconds' => 123
]
]
]
],
'messageTemplateDefinition' => [
'type' => 'MobilePush',
'title' => '<string>',
'body' => '<string>',
'imageUrl' => '<string>'
],
'subscriptionGroupId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "http://localhost:3001/api/admin/broadcasts/execute"

payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"broadcastName\": \"<string>\",\n \"segmentDefinition\": {\n \"entryNode\": {\n \"type\": \"Trait\",\n \"id\": \"<string>\",\n \"path\": \"<string>\",\n \"operator\": {\n \"type\": \"Within\",\n \"windowSeconds\": 123\n }\n },\n \"nodes\": [\n {\n \"type\": \"Trait\",\n \"id\": \"<string>\",\n \"path\": \"<string>\",\n \"operator\": {\n \"type\": \"Within\",\n \"windowSeconds\": 123\n }\n }\n ]\n },\n \"messageTemplateDefinition\": {\n \"type\": \"MobilePush\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"subscriptionGroupId\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "<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/admin/broadcasts/execute")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"broadcastName\": \"<string>\",\n \"segmentDefinition\": {\n \"entryNode\": {\n \"type\": \"Trait\",\n \"id\": \"<string>\",\n \"path\": \"<string>\",\n \"operator\": {\n \"type\": \"Within\",\n \"windowSeconds\": 123\n }\n },\n \"nodes\": [\n {\n \"type\": \"Trait\",\n \"id\": \"<string>\",\n \"path\": \"<string>\",\n \"operator\": {\n \"type\": \"Within\",\n \"windowSeconds\": 123\n }\n }\n ]\n },\n \"messageTemplateDefinition\": {\n \"type\": \"MobilePush\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"subscriptionGroupId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/admin/broadcasts/execute")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"broadcastName\": \"<string>\",\n \"segmentDefinition\": {\n \"entryNode\": {\n \"type\": \"Trait\",\n \"id\": \"<string>\",\n \"path\": \"<string>\",\n \"operator\": {\n \"type\": \"Within\",\n \"windowSeconds\": 123\n }\n },\n \"nodes\": [\n {\n \"type\": \"Trait\",\n \"id\": \"<string>\",\n \"path\": \"<string>\",\n \"operator\": {\n \"type\": \"Within\",\n \"windowSeconds\": 123\n }\n }\n ]\n },\n \"messageTemplateDefinition\": {\n \"type\": \"MobilePush\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"subscriptionGroupId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "broadcastName": "<string>",
  "broadcastId": "<string>"
}

Authorizations

Authorization
string
header
required

Body

application/json
workspaceId
string
required
broadcastName
string
required
segmentDefinition
object
required
messageTemplateDefinition
object
required

Mobile push template resource

subscriptionGroupId
string

Response

200 - application/json

Default Response

broadcastName
string
required
broadcastId
string
required