Create a campaign
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"audience_id": "<string>",
"message_template": "<string>",
"variables": {},
"scheduled_at": "2023-11-07T05:31:56Z",
"throttle_rate": 500,
"recurrence": {
"end_date": "<string>",
"recurrence_end_date": "<string>",
"end_count": 500,
"recurrence_end_count": 500,
"days": [
"<string>"
],
"recurrence_days": [
"<string>"
],
"date": 16,
"recurrence_date": 16,
"cron": "<string>",
"recurrence_cron": "<string>",
"recurrence_interval": 183,
"tz": "<string>"
},
"business_hours_only": true,
"steps": [
{
"order": 1,
"delay_minutes": 262800,
"template": "<string>",
"id": "<string>",
"subject": "<string>"
}
],
"smart_send": false
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns"
payload = {
"name": "<string>",
"description": "<string>",
"audience_id": "<string>",
"message_template": "<string>",
"variables": {},
"scheduled_at": "2023-11-07T05:31:56Z",
"throttle_rate": 500,
"recurrence": {
"end_date": "<string>",
"recurrence_end_date": "<string>",
"end_count": 500,
"recurrence_end_count": 500,
"days": ["<string>"],
"recurrence_days": ["<string>"],
"date": 16,
"recurrence_date": 16,
"cron": "<string>",
"recurrence_cron": "<string>",
"recurrence_interval": 183,
"tz": "<string>"
},
"business_hours_only": True,
"steps": [
{
"order": 1,
"delay_minutes": 262800,
"template": "<string>",
"id": "<string>",
"subject": "<string>"
}
],
"smart_send": False
}
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>',
description: '<string>',
audience_id: '<string>',
message_template: '<string>',
variables: {},
scheduled_at: '2023-11-07T05:31:56Z',
throttle_rate: 500,
recurrence: {
end_date: '<string>',
recurrence_end_date: '<string>',
end_count: 500,
recurrence_end_count: 500,
days: ['<string>'],
recurrence_days: ['<string>'],
date: 16,
recurrence_date: 16,
cron: '<string>',
recurrence_cron: '<string>',
recurrence_interval: 183,
tz: '<string>'
},
business_hours_only: true,
steps: [
{
order: 1,
delay_minutes: 262800,
template: '<string>',
id: '<string>',
subject: '<string>'
}
],
smart_send: false
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns', 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://api.orbit.devotel.io/api/v1/campaigns",
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>',
'description' => '<string>',
'audience_id' => '<string>',
'message_template' => '<string>',
'variables' => [
],
'scheduled_at' => '2023-11-07T05:31:56Z',
'throttle_rate' => 500,
'recurrence' => [
'end_date' => '<string>',
'recurrence_end_date' => '<string>',
'end_count' => 500,
'recurrence_end_count' => 500,
'days' => [
'<string>'
],
'recurrence_days' => [
'<string>'
],
'date' => 16,
'recurrence_date' => 16,
'cron' => '<string>',
'recurrence_cron' => '<string>',
'recurrence_interval' => 183,
'tz' => '<string>'
],
'business_hours_only' => true,
'steps' => [
[
'order' => 1,
'delay_minutes' => 262800,
'template' => '<string>',
'id' => '<string>',
'subject' => '<string>'
]
],
'smart_send' => false
]),
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://api.orbit.devotel.io/api/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"audience_id\": \"<string>\",\n \"message_template\": \"<string>\",\n \"variables\": {},\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"throttle_rate\": 500,\n \"recurrence\": {\n \"end_date\": \"<string>\",\n \"recurrence_end_date\": \"<string>\",\n \"end_count\": 500,\n \"recurrence_end_count\": 500,\n \"days\": [\n \"<string>\"\n ],\n \"recurrence_days\": [\n \"<string>\"\n ],\n \"date\": 16,\n \"recurrence_date\": 16,\n \"cron\": \"<string>\",\n \"recurrence_cron\": \"<string>\",\n \"recurrence_interval\": 183,\n \"tz\": \"<string>\"\n },\n \"business_hours_only\": true,\n \"steps\": [\n {\n \"order\": 1,\n \"delay_minutes\": 262800,\n \"template\": \"<string>\",\n \"id\": \"<string>\",\n \"subject\": \"<string>\"\n }\n ],\n \"smart_send\": false\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://api.orbit.devotel.io/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"audience_id\": \"<string>\",\n \"message_template\": \"<string>\",\n \"variables\": {},\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"throttle_rate\": 500,\n \"recurrence\": {\n \"end_date\": \"<string>\",\n \"recurrence_end_date\": \"<string>\",\n \"end_count\": 500,\n \"recurrence_end_count\": 500,\n \"days\": [\n \"<string>\"\n ],\n \"recurrence_days\": [\n \"<string>\"\n ],\n \"date\": 16,\n \"recurrence_date\": 16,\n \"cron\": \"<string>\",\n \"recurrence_cron\": \"<string>\",\n \"recurrence_interval\": 183,\n \"tz\": \"<string>\"\n },\n \"business_hours_only\": true,\n \"steps\": [\n {\n \"order\": 1,\n \"delay_minutes\": 262800,\n \"template\": \"<string>\",\n \"id\": \"<string>\",\n \"subject\": \"<string>\"\n }\n ],\n \"smart_send\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"audience_id\": \"<string>\",\n \"message_template\": \"<string>\",\n \"variables\": {},\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"throttle_rate\": 500,\n \"recurrence\": {\n \"end_date\": \"<string>\",\n \"recurrence_end_date\": \"<string>\",\n \"end_count\": 500,\n \"recurrence_end_count\": 500,\n \"days\": [\n \"<string>\"\n ],\n \"recurrence_days\": [\n \"<string>\"\n ],\n \"date\": 16,\n \"recurrence_date\": 16,\n \"cron\": \"<string>\",\n \"recurrence_cron\": \"<string>\",\n \"recurrence_interval\": 183,\n \"tz\": \"<string>\"\n },\n \"business_hours_only\": true,\n \"steps\": [\n {\n \"order\": 1,\n \"delay_minutes\": 262800,\n \"template\": \"<string>\",\n \"id\": \"<string>\",\n \"subject\": \"<string>\"\n }\n ],\n \"smart_send\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"type": "<string>",
"channel": "<string>",
"audience_type": "<string>",
"audience_id": "<string>",
"message_template": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Campaigns
Create a campaign
Create a marketing campaign (blast, drip, or journey) targeting an all-contacts / list / segment / CSV / hand-picked-contacts (manual) audience. The campaign is created as a draft until POST /campaigns//send. message_template is optional at creation but mandatory at send-time. For drip campaigns, the steps array defines the sequence; smart_send spreads delivery across 24h using best-time-to-send predictions.
POST
/
api
/
v1
/
campaigns
Create a campaign
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"audience_id": "<string>",
"message_template": "<string>",
"variables": {},
"scheduled_at": "2023-11-07T05:31:56Z",
"throttle_rate": 500,
"recurrence": {
"end_date": "<string>",
"recurrence_end_date": "<string>",
"end_count": 500,
"recurrence_end_count": 500,
"days": [
"<string>"
],
"recurrence_days": [
"<string>"
],
"date": 16,
"recurrence_date": 16,
"cron": "<string>",
"recurrence_cron": "<string>",
"recurrence_interval": 183,
"tz": "<string>"
},
"business_hours_only": true,
"steps": [
{
"order": 1,
"delay_minutes": 262800,
"template": "<string>",
"id": "<string>",
"subject": "<string>"
}
],
"smart_send": false
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns"
payload = {
"name": "<string>",
"description": "<string>",
"audience_id": "<string>",
"message_template": "<string>",
"variables": {},
"scheduled_at": "2023-11-07T05:31:56Z",
"throttle_rate": 500,
"recurrence": {
"end_date": "<string>",
"recurrence_end_date": "<string>",
"end_count": 500,
"recurrence_end_count": 500,
"days": ["<string>"],
"recurrence_days": ["<string>"],
"date": 16,
"recurrence_date": 16,
"cron": "<string>",
"recurrence_cron": "<string>",
"recurrence_interval": 183,
"tz": "<string>"
},
"business_hours_only": True,
"steps": [
{
"order": 1,
"delay_minutes": 262800,
"template": "<string>",
"id": "<string>",
"subject": "<string>"
}
],
"smart_send": False
}
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>',
description: '<string>',
audience_id: '<string>',
message_template: '<string>',
variables: {},
scheduled_at: '2023-11-07T05:31:56Z',
throttle_rate: 500,
recurrence: {
end_date: '<string>',
recurrence_end_date: '<string>',
end_count: 500,
recurrence_end_count: 500,
days: ['<string>'],
recurrence_days: ['<string>'],
date: 16,
recurrence_date: 16,
cron: '<string>',
recurrence_cron: '<string>',
recurrence_interval: 183,
tz: '<string>'
},
business_hours_only: true,
steps: [
{
order: 1,
delay_minutes: 262800,
template: '<string>',
id: '<string>',
subject: '<string>'
}
],
smart_send: false
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns', 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://api.orbit.devotel.io/api/v1/campaigns",
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>',
'description' => '<string>',
'audience_id' => '<string>',
'message_template' => '<string>',
'variables' => [
],
'scheduled_at' => '2023-11-07T05:31:56Z',
'throttle_rate' => 500,
'recurrence' => [
'end_date' => '<string>',
'recurrence_end_date' => '<string>',
'end_count' => 500,
'recurrence_end_count' => 500,
'days' => [
'<string>'
],
'recurrence_days' => [
'<string>'
],
'date' => 16,
'recurrence_date' => 16,
'cron' => '<string>',
'recurrence_cron' => '<string>',
'recurrence_interval' => 183,
'tz' => '<string>'
],
'business_hours_only' => true,
'steps' => [
[
'order' => 1,
'delay_minutes' => 262800,
'template' => '<string>',
'id' => '<string>',
'subject' => '<string>'
]
],
'smart_send' => false
]),
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://api.orbit.devotel.io/api/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"audience_id\": \"<string>\",\n \"message_template\": \"<string>\",\n \"variables\": {},\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"throttle_rate\": 500,\n \"recurrence\": {\n \"end_date\": \"<string>\",\n \"recurrence_end_date\": \"<string>\",\n \"end_count\": 500,\n \"recurrence_end_count\": 500,\n \"days\": [\n \"<string>\"\n ],\n \"recurrence_days\": [\n \"<string>\"\n ],\n \"date\": 16,\n \"recurrence_date\": 16,\n \"cron\": \"<string>\",\n \"recurrence_cron\": \"<string>\",\n \"recurrence_interval\": 183,\n \"tz\": \"<string>\"\n },\n \"business_hours_only\": true,\n \"steps\": [\n {\n \"order\": 1,\n \"delay_minutes\": 262800,\n \"template\": \"<string>\",\n \"id\": \"<string>\",\n \"subject\": \"<string>\"\n }\n ],\n \"smart_send\": false\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://api.orbit.devotel.io/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"audience_id\": \"<string>\",\n \"message_template\": \"<string>\",\n \"variables\": {},\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"throttle_rate\": 500,\n \"recurrence\": {\n \"end_date\": \"<string>\",\n \"recurrence_end_date\": \"<string>\",\n \"end_count\": 500,\n \"recurrence_end_count\": 500,\n \"days\": [\n \"<string>\"\n ],\n \"recurrence_days\": [\n \"<string>\"\n ],\n \"date\": 16,\n \"recurrence_date\": 16,\n \"cron\": \"<string>\",\n \"recurrence_cron\": \"<string>\",\n \"recurrence_interval\": 183,\n \"tz\": \"<string>\"\n },\n \"business_hours_only\": true,\n \"steps\": [\n {\n \"order\": 1,\n \"delay_minutes\": 262800,\n \"template\": \"<string>\",\n \"id\": \"<string>\",\n \"subject\": \"<string>\"\n }\n ],\n \"smart_send\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"audience_id\": \"<string>\",\n \"message_template\": \"<string>\",\n \"variables\": {},\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"throttle_rate\": 500,\n \"recurrence\": {\n \"end_date\": \"<string>\",\n \"recurrence_end_date\": \"<string>\",\n \"end_count\": 500,\n \"recurrence_end_count\": 500,\n \"days\": [\n \"<string>\"\n ],\n \"recurrence_days\": [\n \"<string>\"\n ],\n \"date\": 16,\n \"recurrence_date\": 16,\n \"cron\": \"<string>\",\n \"recurrence_cron\": \"<string>\",\n \"recurrence_interval\": 183,\n \"tz\": \"<string>\"\n },\n \"business_hours_only\": true,\n \"steps\": [\n {\n \"order\": 1,\n \"delay_minutes\": 262800,\n \"template\": \"<string>\",\n \"id\": \"<string>\",\n \"subject\": \"<string>\"\n }\n ],\n \"smart_send\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"type": "<string>",
"channel": "<string>",
"audience_type": "<string>",
"audience_id": "<string>",
"message_template": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
Required string length:
1 - 200Available options:
sms, mms, whatsapp, email, rcs, viber, voice, instagram, messenger, line, push, telegram, fax Maximum string length:
1000Available options:
blast, drip, journey, ad Available options:
all, list, segment, csv, manual Maximum string length:
100000Required range:
0 <= x <= 1000Recurrence config. Accepts either canonical keys (type, end_type, end_date, end_count, days, date, cron) or UI-prefixed keys (recurrence_type, recurrence_end_type, recurrence_end_date, etc.). When end_type === 'on_date' the end_date MUST be in the future; past dates are rejected with HTTP 400.
Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes