Create a broadcast.
curl --request POST \
--url https://dash.dmly.io/api/v1/broadcasts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "June flash sale",
"channel": "9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00",
"audience": {
"type": "segment",
"segment": "all",
"contacts": []
},
"message": {
"template": "promo_june",
"language": "en",
"components": []
},
"schedule": true,
"scheduled_at": "2026-07-01T09:00:00+00:00",
"requires_approval": false,
"type": "contact"
}
'import requests
url = "https://dash.dmly.io/api/v1/broadcasts"
payload = {
"name": "June flash sale",
"channel": "9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00",
"audience": {
"type": "segment",
"segment": "all",
"contacts": []
},
"message": {
"template": "promo_june",
"language": "en",
"components": []
},
"schedule": True,
"scheduled_at": "2026-07-01T09:00:00+00:00",
"requires_approval": False,
"type": "contact"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'June flash sale',
channel: '9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00',
audience: {type: 'segment', segment: 'all', contacts: []},
message: {template: 'promo_june', language: 'en', components: []},
schedule: true,
scheduled_at: '2026-07-01T09:00:00+00:00',
requires_approval: false,
type: 'contact'
})
};
fetch('https://dash.dmly.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://dash.dmly.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([
'name' => 'June flash sale',
'channel' => '9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00',
'audience' => [
'type' => 'segment',
'segment' => 'all',
'contacts' => [
]
],
'message' => [
'template' => 'promo_june',
'language' => 'en',
'components' => [
]
],
'schedule' => true,
'scheduled_at' => '2026-07-01T09:00:00+00:00',
'requires_approval' => false,
'type' => 'contact'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dash.dmly.io/api/v1/broadcasts"
payload := strings.NewReader("{\n \"name\": \"June flash sale\",\n \"channel\": \"9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00\",\n \"audience\": {\n \"type\": \"segment\",\n \"segment\": \"all\",\n \"contacts\": []\n },\n \"message\": {\n \"template\": \"promo_june\",\n \"language\": \"en\",\n \"components\": []\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-07-01T09:00:00+00:00\",\n \"requires_approval\": false,\n \"type\": \"contact\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dash.dmly.io/api/v1/broadcasts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"June flash sale\",\n \"channel\": \"9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00\",\n \"audience\": {\n \"type\": \"segment\",\n \"segment\": \"all\",\n \"contacts\": []\n },\n \"message\": {\n \"template\": \"promo_june\",\n \"language\": \"en\",\n \"components\": []\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-07-01T09:00:00+00:00\",\n \"requires_approval\": false,\n \"type\": \"contact\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/broadcasts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"June flash sale\",\n \"channel\": \"9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00\",\n \"audience\": {\n \"type\": \"segment\",\n \"segment\": \"all\",\n \"contacts\": []\n },\n \"message\": {\n \"template\": \"promo_june\",\n \"language\": \"en\",\n \"components\": []\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-07-01T09:00:00+00:00\",\n \"requires_approval\": false,\n \"type\": \"contact\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Create a broadcast.
Creates a broadcast on the given channel. Status is Draft unless ‘schedule’ is true (then Scheduled). For a retarget campaign, set type=retarget with source_broadcast_id (a prior broadcast uuid) and retarget_engagement; otherwise the audience defines a contact segment. Returns 201 with the created broadcast.
POST
/
broadcasts
Create a broadcast.
curl --request POST \
--url https://dash.dmly.io/api/v1/broadcasts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "June flash sale",
"channel": "9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00",
"audience": {
"type": "segment",
"segment": "all",
"contacts": []
},
"message": {
"template": "promo_june",
"language": "en",
"components": []
},
"schedule": true,
"scheduled_at": "2026-07-01T09:00:00+00:00",
"requires_approval": false,
"type": "contact"
}
'import requests
url = "https://dash.dmly.io/api/v1/broadcasts"
payload = {
"name": "June flash sale",
"channel": "9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00",
"audience": {
"type": "segment",
"segment": "all",
"contacts": []
},
"message": {
"template": "promo_june",
"language": "en",
"components": []
},
"schedule": True,
"scheduled_at": "2026-07-01T09:00:00+00:00",
"requires_approval": False,
"type": "contact"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'June flash sale',
channel: '9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00',
audience: {type: 'segment', segment: 'all', contacts: []},
message: {template: 'promo_june', language: 'en', components: []},
schedule: true,
scheduled_at: '2026-07-01T09:00:00+00:00',
requires_approval: false,
type: 'contact'
})
};
fetch('https://dash.dmly.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://dash.dmly.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([
'name' => 'June flash sale',
'channel' => '9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00',
'audience' => [
'type' => 'segment',
'segment' => 'all',
'contacts' => [
]
],
'message' => [
'template' => 'promo_june',
'language' => 'en',
'components' => [
]
],
'schedule' => true,
'scheduled_at' => '2026-07-01T09:00:00+00:00',
'requires_approval' => false,
'type' => 'contact'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dash.dmly.io/api/v1/broadcasts"
payload := strings.NewReader("{\n \"name\": \"June flash sale\",\n \"channel\": \"9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00\",\n \"audience\": {\n \"type\": \"segment\",\n \"segment\": \"all\",\n \"contacts\": []\n },\n \"message\": {\n \"template\": \"promo_june\",\n \"language\": \"en\",\n \"components\": []\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-07-01T09:00:00+00:00\",\n \"requires_approval\": false,\n \"type\": \"contact\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dash.dmly.io/api/v1/broadcasts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"June flash sale\",\n \"channel\": \"9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00\",\n \"audience\": {\n \"type\": \"segment\",\n \"segment\": \"all\",\n \"contacts\": []\n },\n \"message\": {\n \"template\": \"promo_june\",\n \"language\": \"en\",\n \"components\": []\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-07-01T09:00:00+00:00\",\n \"requires_approval\": false,\n \"type\": \"contact\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/broadcasts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"June flash sale\",\n \"channel\": \"9b1f3c5e-2a44-4f8a-bb21-7d2e9a6c1f00\",\n \"audience\": {\n \"type\": \"segment\",\n \"segment\": \"all\",\n \"contacts\": []\n },\n \"message\": {\n \"template\": \"promo_june\",\n \"language\": \"en\",\n \"components\": []\n },\n \"schedule\": true,\n \"scheduled_at\": \"2026-07-01T09:00:00+00:00\",\n \"requires_approval\": false,\n \"type\": \"contact\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Authorizations
apiKeyAuthbearerAuth
Your workspace API key. It both authenticates the caller and selects the workspace.
Body
application/json
Response
Success.
Was this page helpful?
⌘I

