Resume a journey for a contact from a node
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "contact_01H8XGJ",
"recipient_address": "+14155550123",
"next_node_id": "node_send_2",
"journey_definition": "{\"nodes\":[],\"edges\":[]}"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey"
payload = {
"contact_id": "contact_01H8XGJ",
"recipient_address": "+14155550123",
"next_node_id": "node_send_2",
"journey_definition": "{\"nodes\":[],\"edges\":[]}"
}
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({
contact_id: 'contact_01H8XGJ',
recipient_address: '+14155550123',
next_node_id: 'node_send_2',
journey_definition: '{"nodes":[],"edges":[]}'
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey', 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}/resume-journey",
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([
'contact_id' => 'contact_01H8XGJ',
'recipient_address' => '+14155550123',
'next_node_id' => 'node_send_2',
'journey_definition' => '{"nodes":[],"edges":[]}'
]),
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}/resume-journey"
payload := strings.NewReader("{\n \"contact_id\": \"contact_01H8XGJ\",\n \"recipient_address\": \"+14155550123\",\n \"next_node_id\": \"node_send_2\",\n \"journey_definition\": \"{\\\"nodes\\\":[],\\\"edges\\\":[]}\"\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}/resume-journey")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"contact_01H8XGJ\",\n \"recipient_address\": \"+14155550123\",\n \"next_node_id\": \"node_send_2\",\n \"journey_definition\": \"{\\\"nodes\\\":[],\\\"edges\\\":[]}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey")
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 \"contact_id\": \"contact_01H8XGJ\",\n \"recipient_address\": \"+14155550123\",\n \"next_node_id\": \"node_send_2\",\n \"journey_definition\": \"{\\\"nodes\\\":[],\\\"edges\\\":[]}\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "<string>",
"contact_id": "<string>",
"resumed_from": "<string>",
"done": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Campaigns
Resume a journey for a contact from a node
Resumes a single contact’s journey from a specific node — used to continue an enrollment that was parked at a delay/wait step once its timer elapses. The caller supplies the target contact_id, the recipient’s recipient_address, the next_node_id to run, and the serialized journey_definition. It runs that node chain and reports whether the contact reached a terminal node (done). Primarily invoked by the internal scheduler; returns 202 on success and 400 when required fields are missing or malformed.
POST
/
api
/
v1
/
campaigns
/
{id}
/
resume-journey
Resume a journey for a contact from a node
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "contact_01H8XGJ",
"recipient_address": "+14155550123",
"next_node_id": "node_send_2",
"journey_definition": "{\"nodes\":[],\"edges\":[]}"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey"
payload = {
"contact_id": "contact_01H8XGJ",
"recipient_address": "+14155550123",
"next_node_id": "node_send_2",
"journey_definition": "{\"nodes\":[],\"edges\":[]}"
}
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({
contact_id: 'contact_01H8XGJ',
recipient_address: '+14155550123',
next_node_id: 'node_send_2',
journey_definition: '{"nodes":[],"edges":[]}'
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey', 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}/resume-journey",
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([
'contact_id' => 'contact_01H8XGJ',
'recipient_address' => '+14155550123',
'next_node_id' => 'node_send_2',
'journey_definition' => '{"nodes":[],"edges":[]}'
]),
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}/resume-journey"
payload := strings.NewReader("{\n \"contact_id\": \"contact_01H8XGJ\",\n \"recipient_address\": \"+14155550123\",\n \"next_node_id\": \"node_send_2\",\n \"journey_definition\": \"{\\\"nodes\\\":[],\\\"edges\\\":[]}\"\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}/resume-journey")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"contact_01H8XGJ\",\n \"recipient_address\": \"+14155550123\",\n \"next_node_id\": \"node_send_2\",\n \"journey_definition\": \"{\\\"nodes\\\":[],\\\"edges\\\":[]}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/resume-journey")
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 \"contact_id\": \"contact_01H8XGJ\",\n \"recipient_address\": \"+14155550123\",\n \"next_node_id\": \"node_send_2\",\n \"journey_definition\": \"{\\\"nodes\\\":[],\\\"edges\\\":[]}\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "<string>",
"contact_id": "<string>",
"resumed_from": "<string>",
"done": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Body
application/json
Destination phone number or email for this contact.
Journey node id to resume execution from.
Serialized journey graph (JSON string of nodes and edges).
Optional enrollment id being resumed.
⌘I