Create or replace a campaign's drip steps
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"steps": [
{
"order": 0,
"delay_minutes": 0,
"channel": "sms",
"template": "Hi {{first_name}}, thanks for signing up!"
},
{
"order": 1,
"delay_minutes": 1440,
"channel": "email",
"subject": "Getting started",
"template": "Here's how to make the most of your account.",
"condition": {
"type": "delivered",
"timeout_minutes": 2880
}
}
]
}
EOFimport requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps"
payload = { "steps": [
{
"order": 0,
"delay_minutes": 0,
"channel": "sms",
"template": "Hi {{first_name}}, thanks for signing up!"
},
{
"order": 1,
"delay_minutes": 1440,
"channel": "email",
"subject": "Getting started",
"template": "Here's how to make the most of your account.",
"condition": {
"type": "delivered",
"timeout_minutes": 2880
}
}
] }
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({
steps: [
{
order: 0,
delay_minutes: 0,
channel: 'sms',
template: 'Hi {{first_name}}, thanks for signing up!'
},
{
order: 1,
delay_minutes: 1440,
channel: 'email',
subject: 'Getting started',
template: 'Here\'s how to make the most of your account.',
condition: {type: 'delivered', timeout_minutes: 2880}
}
]
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps', 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/{id}/steps",
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([
'steps' => [
[
'order' => 0,
'delay_minutes' => 0,
'channel' => 'sms',
'template' => 'Hi {{first_name}}, thanks for signing up!'
],
[
'order' => 1,
'delay_minutes' => 1440,
'channel' => 'email',
'subject' => 'Getting started',
'template' => 'Here\'s how to make the most of your account.',
'condition' => [
'type' => 'delivered',
'timeout_minutes' => 2880
]
]
]
]),
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/{id}/steps"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"order\": 0,\n \"delay_minutes\": 0,\n \"channel\": \"sms\",\n \"template\": \"Hi {{first_name}}, thanks for signing up!\"\n },\n {\n \"order\": 1,\n \"delay_minutes\": 1440,\n \"channel\": \"email\",\n \"subject\": \"Getting started\",\n \"template\": \"Here's how to make the most of your account.\",\n \"condition\": {\n \"type\": \"delivered\",\n \"timeout_minutes\": 2880\n }\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("https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"order\": 0,\n \"delay_minutes\": 0,\n \"channel\": \"sms\",\n \"template\": \"Hi {{first_name}}, thanks for signing up!\"\n },\n {\n \"order\": 1,\n \"delay_minutes\": 1440,\n \"channel\": \"email\",\n \"subject\": \"Getting started\",\n \"template\": \"Here's how to make the most of your account.\",\n \"condition\": {\n \"type\": \"delivered\",\n \"timeout_minutes\": 2880\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps")
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 \"steps\": [\n {\n \"order\": 0,\n \"delay_minutes\": 0,\n \"channel\": \"sms\",\n \"template\": \"Hi {{first_name}}, thanks for signing up!\"\n },\n {\n \"order\": 1,\n \"delay_minutes\": 1440,\n \"channel\": \"email\",\n \"subject\": \"Getting started\",\n \"template\": \"Here's how to make the most of your account.\",\n \"condition\": {\n \"type\": \"delivered\",\n \"timeout_minutes\": 2880\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"order": 1,
"delay_minutes": 262800,
"channel": "<string>",
"template": "<string>",
"id": "<string>",
"delay_unit": "minutes",
"subject": "<string>",
"condition": {
"type": "delivered",
"timeout_minutes": 123
}
}
],
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Campaigns
Create or replace a campaign's drip steps
Replaces the full drip-step sequence for a campaign in one call. Post an ordered steps array (1–50 steps); each step sets a send delay, channel, message template, optional email subject, and an optional condition that gates the step on the previous step’s outcome. If the campaign was not already a drip campaign it is converted to one. Steps sent without an id are assigned one on save. Returns the normalized step list.
POST
/
api
/
v1
/
campaigns
/
{id}
/
steps
Create or replace a campaign's drip steps
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"steps": [
{
"order": 0,
"delay_minutes": 0,
"channel": "sms",
"template": "Hi {{first_name}}, thanks for signing up!"
},
{
"order": 1,
"delay_minutes": 1440,
"channel": "email",
"subject": "Getting started",
"template": "Here's how to make the most of your account.",
"condition": {
"type": "delivered",
"timeout_minutes": 2880
}
}
]
}
EOFimport requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps"
payload = { "steps": [
{
"order": 0,
"delay_minutes": 0,
"channel": "sms",
"template": "Hi {{first_name}}, thanks for signing up!"
},
{
"order": 1,
"delay_minutes": 1440,
"channel": "email",
"subject": "Getting started",
"template": "Here's how to make the most of your account.",
"condition": {
"type": "delivered",
"timeout_minutes": 2880
}
}
] }
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({
steps: [
{
order: 0,
delay_minutes: 0,
channel: 'sms',
template: 'Hi {{first_name}}, thanks for signing up!'
},
{
order: 1,
delay_minutes: 1440,
channel: 'email',
subject: 'Getting started',
template: 'Here\'s how to make the most of your account.',
condition: {type: 'delivered', timeout_minutes: 2880}
}
]
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps', 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/{id}/steps",
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([
'steps' => [
[
'order' => 0,
'delay_minutes' => 0,
'channel' => 'sms',
'template' => 'Hi {{first_name}}, thanks for signing up!'
],
[
'order' => 1,
'delay_minutes' => 1440,
'channel' => 'email',
'subject' => 'Getting started',
'template' => 'Here\'s how to make the most of your account.',
'condition' => [
'type' => 'delivered',
'timeout_minutes' => 2880
]
]
]
]),
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/{id}/steps"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"order\": 0,\n \"delay_minutes\": 0,\n \"channel\": \"sms\",\n \"template\": \"Hi {{first_name}}, thanks for signing up!\"\n },\n {\n \"order\": 1,\n \"delay_minutes\": 1440,\n \"channel\": \"email\",\n \"subject\": \"Getting started\",\n \"template\": \"Here's how to make the most of your account.\",\n \"condition\": {\n \"type\": \"delivered\",\n \"timeout_minutes\": 2880\n }\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("https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"order\": 0,\n \"delay_minutes\": 0,\n \"channel\": \"sms\",\n \"template\": \"Hi {{first_name}}, thanks for signing up!\"\n },\n {\n \"order\": 1,\n \"delay_minutes\": 1440,\n \"channel\": \"email\",\n \"subject\": \"Getting started\",\n \"template\": \"Here's how to make the most of your account.\",\n \"condition\": {\n \"type\": \"delivered\",\n \"timeout_minutes\": 2880\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/steps")
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 \"steps\": [\n {\n \"order\": 0,\n \"delay_minutes\": 0,\n \"channel\": \"sms\",\n \"template\": \"Hi {{first_name}}, thanks for signing up!\"\n },\n {\n \"order\": 1,\n \"delay_minutes\": 1440,\n \"channel\": \"email\",\n \"subject\": \"Getting started\",\n \"template\": \"Here's how to make the most of your account.\",\n \"condition\": {\n \"type\": \"delivered\",\n \"timeout_minutes\": 2880\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"order": 1,
"delay_minutes": 262800,
"channel": "<string>",
"template": "<string>",
"id": "<string>",
"delay_unit": "minutes",
"subject": "<string>",
"condition": {
"type": "delivered",
"timeout_minutes": 123
}
}
],
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Body
application/json
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
⌘I