Create a new program
curl --request POST \
--url http://localhost:3000/api/programs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"flowId": "<string>",
"startAt": "2025-12-20T09:00:00Z",
"didPool": [
"123e4567-e89b-12d3-a456-426614174000",
"123e4567-e89b-12d3-a456-426614174001"
],
"retryStrategy": {
"delayMinutes": 123,
"maxRetries": 123,
"retryDates": [
"<string>"
]
},
"mode": "batch",
"audienceId": "<string>",
"stopAt": "2025-12-20T18:00:00Z",
"pauseWindows": {
"sunday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"monday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"tuesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"wednesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"thursday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"friday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"saturday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"advanced": [
{
"startAt": "2025-12-25T00:00:00Z",
"endAt": "2025-12-25T23:59:59Z"
}
]
},
"autoPauseRules": [
{
"nodeId": "node_abc123",
"threshold": 100,
"resetOnResume": true
}
]
}
'import requests
url = "http://localhost:3000/api/programs"
payload = {
"name": "<string>",
"flowId": "<string>",
"startAt": "2025-12-20T09:00:00Z",
"didPool": ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"],
"retryStrategy": {
"delayMinutes": 123,
"maxRetries": 123,
"retryDates": ["<string>"]
},
"mode": "batch",
"audienceId": "<string>",
"stopAt": "2025-12-20T18:00:00Z",
"pauseWindows": {
"sunday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"monday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"tuesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"wednesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"thursday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"friday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"saturday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"advanced": [
{
"startAt": "2025-12-25T00:00:00Z",
"endAt": "2025-12-25T23:59:59Z"
}
]
},
"autoPauseRules": [
{
"nodeId": "node_abc123",
"threshold": 100,
"resetOnResume": 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({
name: '<string>',
flowId: '<string>',
startAt: '2025-12-20T09:00:00Z',
didPool: ['123e4567-e89b-12d3-a456-426614174000', '123e4567-e89b-12d3-a456-426614174001'],
retryStrategy: {delayMinutes: 123, maxRetries: 123, retryDates: ['<string>']},
mode: 'batch',
audienceId: '<string>',
stopAt: '2025-12-20T18:00:00Z',
pauseWindows: {
sunday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
monday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
tuesday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
wednesday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
thursday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
friday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
saturday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
advanced: [{startAt: '2025-12-25T00:00:00Z', endAt: '2025-12-25T23:59:59Z'}]
},
autoPauseRules: [{nodeId: 'node_abc123', threshold: 100, resetOnResume: true}]
})
};
fetch('http://localhost:3000/api/programs', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/programs",
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' => '<string>',
'flowId' => '<string>',
'startAt' => '2025-12-20T09:00:00Z',
'didPool' => [
'123e4567-e89b-12d3-a456-426614174000',
'123e4567-e89b-12d3-a456-426614174001'
],
'retryStrategy' => [
'delayMinutes' => 123,
'maxRetries' => 123,
'retryDates' => [
'<string>'
]
],
'mode' => 'batch',
'audienceId' => '<string>',
'stopAt' => '2025-12-20T18:00:00Z',
'pauseWindows' => [
'sunday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'monday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'tuesday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'wednesday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'thursday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'friday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'saturday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'advanced' => [
[
'startAt' => '2025-12-25T00:00:00Z',
'endAt' => '2025-12-25T23:59:59Z'
]
]
],
'autoPauseRules' => [
[
'nodeId' => 'node_abc123',
'threshold' => 100,
'resetOnResume' => 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 := "http://localhost:3000/api/programs"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"flowId\": \"<string>\",\n \"startAt\": \"2025-12-20T09:00:00Z\",\n \"didPool\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"123e4567-e89b-12d3-a456-426614174001\"\n ],\n \"retryStrategy\": {\n \"delayMinutes\": 123,\n \"maxRetries\": 123,\n \"retryDates\": [\n \"<string>\"\n ]\n },\n \"mode\": \"batch\",\n \"audienceId\": \"<string>\",\n \"stopAt\": \"2025-12-20T18:00:00Z\",\n \"pauseWindows\": {\n \"sunday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"monday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"tuesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"wednesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"thursday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"friday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"saturday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"advanced\": [\n {\n \"startAt\": \"2025-12-25T00:00:00Z\",\n \"endAt\": \"2025-12-25T23:59:59Z\"\n }\n ]\n },\n \"autoPauseRules\": [\n {\n \"nodeId\": \"node_abc123\",\n \"threshold\": 100,\n \"resetOnResume\": true\n }\n ]\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("http://localhost:3000/api/programs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"flowId\": \"<string>\",\n \"startAt\": \"2025-12-20T09:00:00Z\",\n \"didPool\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"123e4567-e89b-12d3-a456-426614174001\"\n ],\n \"retryStrategy\": {\n \"delayMinutes\": 123,\n \"maxRetries\": 123,\n \"retryDates\": [\n \"<string>\"\n ]\n },\n \"mode\": \"batch\",\n \"audienceId\": \"<string>\",\n \"stopAt\": \"2025-12-20T18:00:00Z\",\n \"pauseWindows\": {\n \"sunday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"monday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"tuesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"wednesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"thursday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"friday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"saturday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"advanced\": [\n {\n \"startAt\": \"2025-12-25T00:00:00Z\",\n \"endAt\": \"2025-12-25T23:59:59Z\"\n }\n ]\n },\n \"autoPauseRules\": [\n {\n \"nodeId\": \"node_abc123\",\n \"threshold\": 100,\n \"resetOnResume\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/programs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"flowId\": \"<string>\",\n \"startAt\": \"2025-12-20T09:00:00Z\",\n \"didPool\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"123e4567-e89b-12d3-a456-426614174001\"\n ],\n \"retryStrategy\": {\n \"delayMinutes\": 123,\n \"maxRetries\": 123,\n \"retryDates\": [\n \"<string>\"\n ]\n },\n \"mode\": \"batch\",\n \"audienceId\": \"<string>\",\n \"stopAt\": \"2025-12-20T18:00:00Z\",\n \"pauseWindows\": {\n \"sunday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"monday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"tuesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"wednesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"thursday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"friday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"saturday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"advanced\": [\n {\n \"startAt\": \"2025-12-25T00:00:00Z\",\n \"endAt\": \"2025-12-25T23:59:59Z\"\n }\n ]\n },\n \"autoPauseRules\": [\n {\n \"nodeId\": \"node_abc123\",\n \"threshold\": 100,\n \"resetOnResume\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"audienceId": "<string>",
"flowId": "<string>",
"startAt": "<string>",
"didPool": [
{
"id": "<string>",
"number": "+212500000001",
"country": "MA"
}
],
"retryStrategy": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"triggerCondition": {
"type": "date",
"attributeName": "date_echeance",
"direction": "before",
"offset": {
"days": 2,
"hours": 15,
"minutes": 0
}
},
"stopAt": "<string>",
"pauseWindows": {},
"autoPauseRules": {}
}Programs
Create a new program
POST
/
api
/
programs
Create a new program
curl --request POST \
--url http://localhost:3000/api/programs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"flowId": "<string>",
"startAt": "2025-12-20T09:00:00Z",
"didPool": [
"123e4567-e89b-12d3-a456-426614174000",
"123e4567-e89b-12d3-a456-426614174001"
],
"retryStrategy": {
"delayMinutes": 123,
"maxRetries": 123,
"retryDates": [
"<string>"
]
},
"mode": "batch",
"audienceId": "<string>",
"stopAt": "2025-12-20T18:00:00Z",
"pauseWindows": {
"sunday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"monday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"tuesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"wednesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"thursday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"friday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"saturday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"advanced": [
{
"startAt": "2025-12-25T00:00:00Z",
"endAt": "2025-12-25T23:59:59Z"
}
]
},
"autoPauseRules": [
{
"nodeId": "node_abc123",
"threshold": 100,
"resetOnResume": true
}
]
}
'import requests
url = "http://localhost:3000/api/programs"
payload = {
"name": "<string>",
"flowId": "<string>",
"startAt": "2025-12-20T09:00:00Z",
"didPool": ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"],
"retryStrategy": {
"delayMinutes": 123,
"maxRetries": 123,
"retryDates": ["<string>"]
},
"mode": "batch",
"audienceId": "<string>",
"stopAt": "2025-12-20T18:00:00Z",
"pauseWindows": {
"sunday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"monday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"tuesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"wednesday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"thursday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"friday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"saturday": [
{
"startAt": {
"hour": 12,
"minute": 0
},
"endAt": {
"hour": 12,
"minute": 0
}
}
],
"advanced": [
{
"startAt": "2025-12-25T00:00:00Z",
"endAt": "2025-12-25T23:59:59Z"
}
]
},
"autoPauseRules": [
{
"nodeId": "node_abc123",
"threshold": 100,
"resetOnResume": 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({
name: '<string>',
flowId: '<string>',
startAt: '2025-12-20T09:00:00Z',
didPool: ['123e4567-e89b-12d3-a456-426614174000', '123e4567-e89b-12d3-a456-426614174001'],
retryStrategy: {delayMinutes: 123, maxRetries: 123, retryDates: ['<string>']},
mode: 'batch',
audienceId: '<string>',
stopAt: '2025-12-20T18:00:00Z',
pauseWindows: {
sunday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
monday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
tuesday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
wednesday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
thursday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
friday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
saturday: [{startAt: {hour: 12, minute: 0}, endAt: {hour: 12, minute: 0}}],
advanced: [{startAt: '2025-12-25T00:00:00Z', endAt: '2025-12-25T23:59:59Z'}]
},
autoPauseRules: [{nodeId: 'node_abc123', threshold: 100, resetOnResume: true}]
})
};
fetch('http://localhost:3000/api/programs', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/programs",
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' => '<string>',
'flowId' => '<string>',
'startAt' => '2025-12-20T09:00:00Z',
'didPool' => [
'123e4567-e89b-12d3-a456-426614174000',
'123e4567-e89b-12d3-a456-426614174001'
],
'retryStrategy' => [
'delayMinutes' => 123,
'maxRetries' => 123,
'retryDates' => [
'<string>'
]
],
'mode' => 'batch',
'audienceId' => '<string>',
'stopAt' => '2025-12-20T18:00:00Z',
'pauseWindows' => [
'sunday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'monday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'tuesday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'wednesday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'thursday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'friday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'saturday' => [
[
'startAt' => [
'hour' => 12,
'minute' => 0
],
'endAt' => [
'hour' => 12,
'minute' => 0
]
]
],
'advanced' => [
[
'startAt' => '2025-12-25T00:00:00Z',
'endAt' => '2025-12-25T23:59:59Z'
]
]
],
'autoPauseRules' => [
[
'nodeId' => 'node_abc123',
'threshold' => 100,
'resetOnResume' => 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 := "http://localhost:3000/api/programs"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"flowId\": \"<string>\",\n \"startAt\": \"2025-12-20T09:00:00Z\",\n \"didPool\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"123e4567-e89b-12d3-a456-426614174001\"\n ],\n \"retryStrategy\": {\n \"delayMinutes\": 123,\n \"maxRetries\": 123,\n \"retryDates\": [\n \"<string>\"\n ]\n },\n \"mode\": \"batch\",\n \"audienceId\": \"<string>\",\n \"stopAt\": \"2025-12-20T18:00:00Z\",\n \"pauseWindows\": {\n \"sunday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"monday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"tuesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"wednesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"thursday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"friday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"saturday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"advanced\": [\n {\n \"startAt\": \"2025-12-25T00:00:00Z\",\n \"endAt\": \"2025-12-25T23:59:59Z\"\n }\n ]\n },\n \"autoPauseRules\": [\n {\n \"nodeId\": \"node_abc123\",\n \"threshold\": 100,\n \"resetOnResume\": true\n }\n ]\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("http://localhost:3000/api/programs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"flowId\": \"<string>\",\n \"startAt\": \"2025-12-20T09:00:00Z\",\n \"didPool\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"123e4567-e89b-12d3-a456-426614174001\"\n ],\n \"retryStrategy\": {\n \"delayMinutes\": 123,\n \"maxRetries\": 123,\n \"retryDates\": [\n \"<string>\"\n ]\n },\n \"mode\": \"batch\",\n \"audienceId\": \"<string>\",\n \"stopAt\": \"2025-12-20T18:00:00Z\",\n \"pauseWindows\": {\n \"sunday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"monday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"tuesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"wednesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"thursday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"friday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"saturday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"advanced\": [\n {\n \"startAt\": \"2025-12-25T00:00:00Z\",\n \"endAt\": \"2025-12-25T23:59:59Z\"\n }\n ]\n },\n \"autoPauseRules\": [\n {\n \"nodeId\": \"node_abc123\",\n \"threshold\": 100,\n \"resetOnResume\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/programs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"flowId\": \"<string>\",\n \"startAt\": \"2025-12-20T09:00:00Z\",\n \"didPool\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"123e4567-e89b-12d3-a456-426614174001\"\n ],\n \"retryStrategy\": {\n \"delayMinutes\": 123,\n \"maxRetries\": 123,\n \"retryDates\": [\n \"<string>\"\n ]\n },\n \"mode\": \"batch\",\n \"audienceId\": \"<string>\",\n \"stopAt\": \"2025-12-20T18:00:00Z\",\n \"pauseWindows\": {\n \"sunday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"monday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"tuesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"wednesday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"thursday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"friday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"saturday\": [\n {\n \"startAt\": {\n \"hour\": 12,\n \"minute\": 0\n },\n \"endAt\": {\n \"hour\": 12,\n \"minute\": 0\n }\n }\n ],\n \"advanced\": [\n {\n \"startAt\": \"2025-12-25T00:00:00Z\",\n \"endAt\": \"2025-12-25T23:59:59Z\"\n }\n ]\n },\n \"autoPauseRules\": [\n {\n \"nodeId\": \"node_abc123\",\n \"threshold\": 100,\n \"resetOnResume\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"audienceId": "<string>",
"flowId": "<string>",
"startAt": "<string>",
"didPool": [
{
"id": "<string>",
"number": "+212500000001",
"country": "MA"
}
],
"retryStrategy": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"triggerCondition": {
"type": "date",
"attributeName": "date_echeance",
"direction": "before",
"offset": {
"days": 2,
"hours": 15,
"minutes": 0
}
},
"stopAt": "<string>",
"pauseWindows": {},
"autoPauseRules": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Program name
Flow ID to execute
Scheduled start time (ISO 8601)
Example:
"2025-12-20T09:00:00Z"
Pool of DID UUIDs to use for outbound calls (at least one)
Example:
[
"123e4567-e89b-12d3-a456-426614174000",
"123e4567-e89b-12d3-a456-426614174001"
]
Retry strategy for failed calls
Show child attributes
Show child attributes
Program mode: batch (static audience) or live (trigger-based)
Available options:
batch, live Audience ID to call (required for batch mode)
Trigger condition (required for live mode)
Show child attributes
Show child attributes
Scheduled stop time (ISO 8601)
Example:
"2025-12-20T18:00:00Z"
Show child attributes
Show child attributes
Auto-pause rules: pause execution when counters reach thresholds
Show child attributes
Show child attributes
Response
Program created
Program ID
Program name
Program mode
Available options:
batch, live Organization ID
Audience ID. Set at creation for batch, auto-created for live.
Flow ID
Program lifecycle status. Operational status is on executions.
Available options:
draft, active, archived Scheduled start time
Resolved DID pool
Show child attributes
Show child attributes
Retry strategy
Created at
Updated at
Trigger condition (live mode only)
Show child attributes
Show child attributes
Scheduled stop time
Pause windows
Auto-pause rules
⌘I