Skip to main content
POST
/
broadcasts
Create a new broadcast
curl --request POST \
  --url https://messenger-public-api.cogfy.com/broadcasts \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "type": "text",
  "title": "<string>",
  "content": "<string>",
  "phoneNumberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contactsQuery": {
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}
'
import requests

url = "https://messenger-public-api.cogfy.com/broadcasts"

payload = {
"type": "text",
"title": "<string>",
"content": "<string>",
"phoneNumberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactsQuery": { "tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
] }
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'text',
title: '<string>',
content: '<string>',
phoneNumberId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
contactsQuery: {tags: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', name: '<string>'}]}
})
};

fetch('https://messenger-public-api.cogfy.com/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://messenger-public-api.cogfy.com/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([
'type' => 'text',
'title' => '<string>',
'content' => '<string>',
'phoneNumberId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'contactsQuery' => [
'tags' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://messenger-public-api.cogfy.com/broadcasts"

payload := strings.NewReader("{\n \"type\": \"text\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"phoneNumberId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactsQuery\": {\n \"tags\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n }\n ]\n }\n}")

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

req.Header.Add("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://messenger-public-api.cogfy.com/broadcasts")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"text\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"phoneNumberId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactsQuery\": {\n \"tags\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n }\n ]\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://messenger-public-api.cogfy.com/broadcasts")

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

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"text\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"phoneNumberId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactsQuery\": {\n \"tags\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n }\n ]\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

api-key
string
header
required

Body

application/json
type
enum<string>

The type of the broadcast message.

Available options:
text
title
string

The title of the broadcast message.

Maximum string length: 100
content
string

The content of the broadcast message.

Maximum string length: 1024
phoneNumberId
string<uuid>

The ID of the phone number to use for the broadcast.

contactsQuery
object

Response

Broadcast created successfully

id
string<uuid>

The ID of the created broadcast.