Calculate auto-segmented campaign schedule
curl --request POST \
--url https://your-instance.example.com/api/campaigns/auto-segment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"totalContacts": 500,
"firstSegmentDate": "2026-05-20",
"firstSegmentTime": "10:00"
}
'import requests
url = "https://your-instance.example.com/api/campaigns/auto-segment"
payload = {
"totalContacts": 500,
"firstSegmentDate": "2026-05-20",
"firstSegmentTime": "10:00"
}
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({totalContacts: 500, firstSegmentDate: '2026-05-20', firstSegmentTime: '10:00'})
};
fetch('https://your-instance.example.com/api/campaigns/auto-segment', 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://your-instance.example.com/api/campaigns/auto-segment",
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([
'totalContacts' => 500,
'firstSegmentDate' => '2026-05-20',
'firstSegmentTime' => '10:00'
]),
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://your-instance.example.com/api/campaigns/auto-segment"
payload := strings.NewReader("{\n \"totalContacts\": 500,\n \"firstSegmentDate\": \"2026-05-20\",\n \"firstSegmentTime\": \"10:00\"\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://your-instance.example.com/api/campaigns/auto-segment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"totalContacts\": 500,\n \"firstSegmentDate\": \"2026-05-20\",\n \"firstSegmentTime\": \"10:00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/auto-segment")
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 \"totalContacts\": 500,\n \"firstSegmentDate\": \"2026-05-20\",\n \"firstSegmentTime\": \"10:00\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"segments": [
{
"id": "seg-1",
"scheduledDate": "2026-05-20T17:00:00.000Z",
"contactCount": 100
},
{
"id": "seg-2",
"scheduledDate": "2026-05-21T17:00:00.000Z",
"contactCount": 100
}
],
"totalSegments": 5,
"warnings": []
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}Campaigns
Calculate auto-segmented campaign schedule
Returns a suggested segment schedule for a campaign given the total contact count. For limited plans the response respects the organization’s daily SMS quota and skips fully booked days; for unlimited plans contacts are split into 100-per-day segments. Each segment carries a UTC ISO scheduledDate.
POST
/
api
/
campaigns
/
auto-segment
Calculate auto-segmented campaign schedule
curl --request POST \
--url https://your-instance.example.com/api/campaigns/auto-segment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"totalContacts": 500,
"firstSegmentDate": "2026-05-20",
"firstSegmentTime": "10:00"
}
'import requests
url = "https://your-instance.example.com/api/campaigns/auto-segment"
payload = {
"totalContacts": 500,
"firstSegmentDate": "2026-05-20",
"firstSegmentTime": "10:00"
}
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({totalContacts: 500, firstSegmentDate: '2026-05-20', firstSegmentTime: '10:00'})
};
fetch('https://your-instance.example.com/api/campaigns/auto-segment', 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://your-instance.example.com/api/campaigns/auto-segment",
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([
'totalContacts' => 500,
'firstSegmentDate' => '2026-05-20',
'firstSegmentTime' => '10:00'
]),
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://your-instance.example.com/api/campaigns/auto-segment"
payload := strings.NewReader("{\n \"totalContacts\": 500,\n \"firstSegmentDate\": \"2026-05-20\",\n \"firstSegmentTime\": \"10:00\"\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://your-instance.example.com/api/campaigns/auto-segment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"totalContacts\": 500,\n \"firstSegmentDate\": \"2026-05-20\",\n \"firstSegmentTime\": \"10:00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/auto-segment")
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 \"totalContacts\": 500,\n \"firstSegmentDate\": \"2026-05-20\",\n \"firstSegmentTime\": \"10:00\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"segments": [
{
"id": "seg-1",
"scheduledDate": "2026-05-20T17:00:00.000Z",
"contactCount": 100
},
{
"id": "seg-2",
"scheduledDate": "2026-05-21T17:00:00.000Z",
"contactCount": 100
}
],
"totalSegments": 5,
"warnings": []
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
⌘I