Skip to main content
PUT
/
api
/
admin
/
journeys
/
cURL
curl --request PUT \
  --url http://localhost:3001/api/admin/journeys/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "draft": {
    "nodes": [
      {
        "id": "<string>",
        "data": {
          "type": "JourneyUiNodeDefinitionProps",
          "nodeTypeProps": {
            "type": "EntryUiNode",
            "variant": {
              "type": "EntryNode",
              "segment": "<string>",
              "child": "<string>",
              "reEnter": true
            }
          }
        }
      }
    ],
    "edges": [
      {
        "source": "<string>",
        "target": "<string>",
        "data": {
          "type": "JourneyUiDefinitionEdgeProps",
          "disableMarker": true
        }
      }
    ]
  },
  "canRunMultiple": true,
  "updatedAt": 123,
  "status": "NotStarted"
}
'
import requests

url = "http://localhost:3001/api/admin/journeys/"

payload = {
"workspaceId": "<string>",
"id": "<string>",
"name": "<string>",
"draft": {
"nodes": [
{
"id": "<string>",
"data": {
"type": "JourneyUiNodeDefinitionProps",
"nodeTypeProps": {
"type": "EntryUiNode",
"variant": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>",
"reEnter": True
}
}
}
}
],
"edges": [
{
"source": "<string>",
"target": "<string>",
"data": {
"type": "JourneyUiDefinitionEdgeProps",
"disableMarker": True
}
}
]
},
"canRunMultiple": True,
"updatedAt": 123,
"status": "NotStarted"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
id: '<string>',
name: '<string>',
draft: {
nodes: [
{
id: '<string>',
data: {
type: 'JourneyUiNodeDefinitionProps',
nodeTypeProps: {
type: 'EntryUiNode',
variant: {type: 'EntryNode', segment: '<string>', child: '<string>', reEnter: true}
}
}
}
],
edges: [
{
source: '<string>',
target: '<string>',
data: {type: 'JourneyUiDefinitionEdgeProps', disableMarker: true}
}
]
},
canRunMultiple: true,
updatedAt: 123,
status: 'NotStarted'
})
};

fetch('http://localhost:3001/api/admin/journeys/', 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 => "3001",
CURLOPT_URL => "http://localhost:3001/api/admin/journeys/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'id' => '<string>',
'name' => '<string>',
'draft' => [
'nodes' => [
[
'id' => '<string>',
'data' => [
'type' => 'JourneyUiNodeDefinitionProps',
'nodeTypeProps' => [
'type' => 'EntryUiNode',
'variant' => [
'type' => 'EntryNode',
'segment' => '<string>',
'child' => '<string>',
'reEnter' => true
]
]
]
]
],
'edges' => [
[
'source' => '<string>',
'target' => '<string>',
'data' => [
'type' => 'JourneyUiDefinitionEdgeProps',
'disableMarker' => true
]
]
]
],
'canRunMultiple' => true,
'updatedAt' => 123,
'status' => 'NotStarted'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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:3001/api/admin/journeys/"

payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"draft\": {\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"data\": {\n \"type\": \"JourneyUiNodeDefinitionProps\",\n \"nodeTypeProps\": {\n \"type\": \"EntryUiNode\",\n \"variant\": {\n \"type\": \"EntryNode\",\n \"segment\": \"<string>\",\n \"child\": \"<string>\",\n \"reEnter\": true\n }\n }\n }\n }\n ],\n \"edges\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"data\": {\n \"type\": \"JourneyUiDefinitionEdgeProps\",\n \"disableMarker\": true\n }\n }\n ]\n },\n \"canRunMultiple\": true,\n \"updatedAt\": 123,\n \"status\": \"NotStarted\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "<api-key>")
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.put("http://localhost:3001/api/admin/journeys/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"draft\": {\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"data\": {\n \"type\": \"JourneyUiNodeDefinitionProps\",\n \"nodeTypeProps\": {\n \"type\": \"EntryUiNode\",\n \"variant\": {\n \"type\": \"EntryNode\",\n \"segment\": \"<string>\",\n \"child\": \"<string>\",\n \"reEnter\": true\n }\n }\n }\n }\n ],\n \"edges\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"data\": {\n \"type\": \"JourneyUiDefinitionEdgeProps\",\n \"disableMarker\": true\n }\n }\n ]\n },\n \"canRunMultiple\": true,\n \"updatedAt\": 123,\n \"status\": \"NotStarted\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/admin/journeys/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"draft\": {\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"data\": {\n \"type\": \"JourneyUiNodeDefinitionProps\",\n \"nodeTypeProps\": {\n \"type\": \"EntryUiNode\",\n \"variant\": {\n \"type\": \"EntryNode\",\n \"segment\": \"<string>\",\n \"child\": \"<string>\",\n \"reEnter\": true\n }\n }\n }\n }\n ],\n \"edges\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"data\": {\n \"type\": \"JourneyUiDefinitionEdgeProps\",\n \"disableMarker\": true\n }\n }\n ]\n },\n \"canRunMultiple\": true,\n \"updatedAt\": 123,\n \"status\": \"NotStarted\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "workspaceId": "<string>",
  "name": "<string>",
  "updatedAt": 123,
  "status": "NotStarted",
  "createdAt": 123,
  "canRunMultiple": true,
  "draft": {
    "nodes": [
      {
        "id": "<string>",
        "data": {
          "type": "JourneyUiNodeDefinitionProps",
          "nodeTypeProps": {
            "type": "EntryUiNode",
            "variant": {
              "type": "EntryNode",
              "segment": "<string>",
              "child": "<string>",
              "reEnter": true
            }
          }
        }
      }
    ],
    "edges": [
      {
        "source": "<string>",
        "target": "<string>",
        "data": {
          "type": "JourneyUiDefinitionEdgeProps",
          "disableMarker": true
        }
      }
    ]
  },
  "definition": {
    "entryNode": {
      "type": "EntryNode",
      "segment": "<string>",
      "child": "<string>",
      "reEnter": true
    },
    "exitNode": {
      "type": "ExitNode"
    },
    "nodes": [
      {
        "id": "<string>",
        "type": "DelayNode",
        "variant": {
          "type": "Second",
          "seconds": 123
        },
        "child": "<string>"
      }
    ]
  }
}
{
"type": "ConstraintViolation",
"violations": [
{
"type": "WaitForNodeAndEventEntryNode",
"message": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Body

application/json
workspaceId
string
required
id
name
draft
object | null
canRunMultiple
boolean
updatedAt
number
definition
object
status
Available options:
NotStarted

Response

Default Response

id
string
required
workspaceId
string
required
name
string
required
updatedAt
number
required
status
enum<string>
required
Available options:
NotStarted
createdAt
number
required
canRunMultiple
boolean
draft
object
definition
object