Journeys
Update draft
Replace a draft journey’s whole graph. Only drafts can be edited; published versions are frozen (edit a live journey in the app to fork a new draft). Omit node positions and the server lays the graph out automatically.
PATCH
/
api
/
v1
/
journeys
/
{journeyId}
Update draft
curl --request PATCH \
--url https://www.useboom.ai/api/v1/journeys/{journeyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"name": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"inputs": {
"description": "<string>",
"segmentId": "<string>",
"segmentName": "<string>",
"eventName": "<string>",
"maxEnrollments": 4503599627370496,
"enrollmentWindow": "<string>"
}
}
],
"edges": [
{
"from": "<string>",
"to": "<string>",
"sourceHandle": "<string>",
"metadata": {
"signalDescription": "<string>"
}
}
],
"id": "<string>",
"metadata": {
"initiativeType": "<string>",
"version": 0
}
}
}
'import requests
url = "https://www.useboom.ai/api/v1/journeys/{journeyId}"
payload = { "definition": {
"name": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"inputs": {
"description": "<string>",
"segmentId": "<string>",
"segmentName": "<string>",
"eventName": "<string>",
"maxEnrollments": 4503599627370496,
"enrollmentWindow": "<string>"
}
}
],
"edges": [
{
"from": "<string>",
"to": "<string>",
"sourceHandle": "<string>",
"metadata": { "signalDescription": "<string>" }
}
],
"id": "<string>",
"metadata": {
"initiativeType": "<string>",
"version": 0
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition: {
name: '<string>',
actions: [
{
id: '<string>',
kind: '<string>',
name: '<string>',
inputs: {
description: '<string>',
segmentId: '<string>',
segmentName: '<string>',
eventName: '<string>',
maxEnrollments: 4503599627370496,
enrollmentWindow: '<string>'
}
}
],
edges: [
{
from: '<string>',
to: '<string>',
sourceHandle: '<string>',
metadata: {signalDescription: '<string>'}
}
],
id: '<string>',
metadata: {initiativeType: '<string>', version: 0}
}
})
};
fetch('https://www.useboom.ai/api/v1/journeys/{journeyId}', 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://www.useboom.ai/api/v1/journeys/{journeyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'definition' => [
'name' => '<string>',
'actions' => [
[
'id' => '<string>',
'kind' => '<string>',
'name' => '<string>',
'inputs' => [
'description' => '<string>',
'segmentId' => '<string>',
'segmentName' => '<string>',
'eventName' => '<string>',
'maxEnrollments' => 4503599627370496,
'enrollmentWindow' => '<string>'
]
]
],
'edges' => [
[
'from' => '<string>',
'to' => '<string>',
'sourceHandle' => '<string>',
'metadata' => [
'signalDescription' => '<string>'
]
]
],
'id' => '<string>',
'metadata' => [
'initiativeType' => '<string>',
'version' => 0
]
]
]),
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://www.useboom.ai/api/v1/journeys/{journeyId}"
payload := strings.NewReader("{\n \"definition\": {\n \"name\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"inputs\": {\n \"description\": \"<string>\",\n \"segmentId\": \"<string>\",\n \"segmentName\": \"<string>\",\n \"eventName\": \"<string>\",\n \"maxEnrollments\": 4503599627370496,\n \"enrollmentWindow\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"metadata\": {\n \"signalDescription\": \"<string>\"\n }\n }\n ],\n \"id\": \"<string>\",\n \"metadata\": {\n \"initiativeType\": \"<string>\",\n \"version\": 0\n }\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://www.useboom.ai/api/v1/journeys/{journeyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"name\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"inputs\": {\n \"description\": \"<string>\",\n \"segmentId\": \"<string>\",\n \"segmentName\": \"<string>\",\n \"eventName\": \"<string>\",\n \"maxEnrollments\": 4503599627370496,\n \"enrollmentWindow\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"metadata\": {\n \"signalDescription\": \"<string>\"\n }\n }\n ],\n \"id\": \"<string>\",\n \"metadata\": {\n \"initiativeType\": \"<string>\",\n \"version\": 0\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/journeys/{journeyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition\": {\n \"name\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"inputs\": {\n \"description\": \"<string>\",\n \"segmentId\": \"<string>\",\n \"segmentName\": \"<string>\",\n \"eventName\": \"<string>\",\n \"maxEnrollments\": 4503599627370496,\n \"enrollmentWindow\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"metadata\": {\n \"signalDescription\": \"<string>\"\n }\n }\n ],\n \"id\": \"<string>\",\n \"metadata\": {\n \"initiativeType\": \"<string>\",\n \"version\": 0\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"initiativeId": "<string>",
"version": 0,
"definition": {
"name": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"position": {
"x": 123,
"y": 123
},
"inputs": {
"description": "<string>",
"segmentId": "<string>",
"segmentName": "<string>",
"eventName": "<string>",
"maxEnrollments": 4503599627370496,
"enrollmentWindow": "<string>"
}
}
],
"edges": [
{
"from": "<string>",
"to": "<string>",
"sourceHandle": "<string>",
"metadata": {
"signalDescription": "<string>"
}
}
],
"id": "<string>",
"metadata": {
"initiativeType": "<string>",
"version": 0,
"cancelOnEvents": {
"eventNames": [
"<string>"
]
}
}
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Organization API key, sent as Authorization: Bearer boom_org_....
Path Parameters
A draft journey id, or the initiative id (resolves to its current draft).
Minimum string length:
1Body
application/json
The full journey graph. Drafts may be incomplete; run journeys_validate before publishing.
Show child attributes
Show child attributes
Response
Success
Journey (workflow version) id.
The initiative this journey belongs to.
DRAFT (editable), PUBLISHED (live, frozen), or STOPPED (retired).
Available options:
DRAFT, PUBLISHED, STOPPED Version number within the initiative.
Required range:
-9007199254740991 <= x <= 9007199254740991The full journey graph.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update draft
curl --request PATCH \
--url https://www.useboom.ai/api/v1/journeys/{journeyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"name": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"inputs": {
"description": "<string>",
"segmentId": "<string>",
"segmentName": "<string>",
"eventName": "<string>",
"maxEnrollments": 4503599627370496,
"enrollmentWindow": "<string>"
}
}
],
"edges": [
{
"from": "<string>",
"to": "<string>",
"sourceHandle": "<string>",
"metadata": {
"signalDescription": "<string>"
}
}
],
"id": "<string>",
"metadata": {
"initiativeType": "<string>",
"version": 0
}
}
}
'import requests
url = "https://www.useboom.ai/api/v1/journeys/{journeyId}"
payload = { "definition": {
"name": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"inputs": {
"description": "<string>",
"segmentId": "<string>",
"segmentName": "<string>",
"eventName": "<string>",
"maxEnrollments": 4503599627370496,
"enrollmentWindow": "<string>"
}
}
],
"edges": [
{
"from": "<string>",
"to": "<string>",
"sourceHandle": "<string>",
"metadata": { "signalDescription": "<string>" }
}
],
"id": "<string>",
"metadata": {
"initiativeType": "<string>",
"version": 0
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition: {
name: '<string>',
actions: [
{
id: '<string>',
kind: '<string>',
name: '<string>',
inputs: {
description: '<string>',
segmentId: '<string>',
segmentName: '<string>',
eventName: '<string>',
maxEnrollments: 4503599627370496,
enrollmentWindow: '<string>'
}
}
],
edges: [
{
from: '<string>',
to: '<string>',
sourceHandle: '<string>',
metadata: {signalDescription: '<string>'}
}
],
id: '<string>',
metadata: {initiativeType: '<string>', version: 0}
}
})
};
fetch('https://www.useboom.ai/api/v1/journeys/{journeyId}', 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://www.useboom.ai/api/v1/journeys/{journeyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'definition' => [
'name' => '<string>',
'actions' => [
[
'id' => '<string>',
'kind' => '<string>',
'name' => '<string>',
'inputs' => [
'description' => '<string>',
'segmentId' => '<string>',
'segmentName' => '<string>',
'eventName' => '<string>',
'maxEnrollments' => 4503599627370496,
'enrollmentWindow' => '<string>'
]
]
],
'edges' => [
[
'from' => '<string>',
'to' => '<string>',
'sourceHandle' => '<string>',
'metadata' => [
'signalDescription' => '<string>'
]
]
],
'id' => '<string>',
'metadata' => [
'initiativeType' => '<string>',
'version' => 0
]
]
]),
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://www.useboom.ai/api/v1/journeys/{journeyId}"
payload := strings.NewReader("{\n \"definition\": {\n \"name\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"inputs\": {\n \"description\": \"<string>\",\n \"segmentId\": \"<string>\",\n \"segmentName\": \"<string>\",\n \"eventName\": \"<string>\",\n \"maxEnrollments\": 4503599627370496,\n \"enrollmentWindow\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"metadata\": {\n \"signalDescription\": \"<string>\"\n }\n }\n ],\n \"id\": \"<string>\",\n \"metadata\": {\n \"initiativeType\": \"<string>\",\n \"version\": 0\n }\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://www.useboom.ai/api/v1/journeys/{journeyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"name\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"inputs\": {\n \"description\": \"<string>\",\n \"segmentId\": \"<string>\",\n \"segmentName\": \"<string>\",\n \"eventName\": \"<string>\",\n \"maxEnrollments\": 4503599627370496,\n \"enrollmentWindow\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"metadata\": {\n \"signalDescription\": \"<string>\"\n }\n }\n ],\n \"id\": \"<string>\",\n \"metadata\": {\n \"initiativeType\": \"<string>\",\n \"version\": 0\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/journeys/{journeyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition\": {\n \"name\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"<string>\",\n \"kind\": \"<string>\",\n \"name\": \"<string>\",\n \"inputs\": {\n \"description\": \"<string>\",\n \"segmentId\": \"<string>\",\n \"segmentName\": \"<string>\",\n \"eventName\": \"<string>\",\n \"maxEnrollments\": 4503599627370496,\n \"enrollmentWindow\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"metadata\": {\n \"signalDescription\": \"<string>\"\n }\n }\n ],\n \"id\": \"<string>\",\n \"metadata\": {\n \"initiativeType\": \"<string>\",\n \"version\": 0\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"initiativeId": "<string>",
"version": 0,
"definition": {
"name": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"position": {
"x": 123,
"y": 123
},
"inputs": {
"description": "<string>",
"segmentId": "<string>",
"segmentName": "<string>",
"eventName": "<string>",
"maxEnrollments": 4503599627370496,
"enrollmentWindow": "<string>"
}
}
],
"edges": [
{
"from": "<string>",
"to": "<string>",
"sourceHandle": "<string>",
"metadata": {
"signalDescription": "<string>"
}
}
],
"id": "<string>",
"metadata": {
"initiativeType": "<string>",
"version": 0,
"cancelOnEvents": {
"eventNames": [
"<string>"
]
}
}
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}