Save draft version (or validate-only for import gate)

Requires ADMIN. validateOnly:true runs full graph+effect validation and returns { valid:true } or 422, writing nothing. Otherwise saves/updates the draft version (draft saves validate effect props but not full graph).

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

required

string

Automation (journey) identifier.

Request Body^required

application/json

object

definition

required

Journey/automation graph definition. Nodes are typed (trigger/action/branch/wait/waitForEvent/timeWindow).

object

nodes

required

Array<object>

>= 1 items

object

key

additional properties

any

key

additional properties

any

validateOnly

boolean

Example^generated

1
{
2
  "definition": {
3
    "nodes": [
4
      {}
5
    ]
6
  },
7
  "validateOnly": true
8
}

Responses

200

Draft saved (existing draft updated) or { valid:true } for validateOnly.

application/json

object

valid

boolean

versionId

string

version

integer

status

string

201

New draft version created.

application/json

object

versionId

string

version

integer

status

string

Example

1
{
2
  "status": "draft"
3
}

400

Missing/invalid path input (e.g. projectId) or invalid JSON body.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

404

Resource not found (or cross-tenant — same 404).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

422

Param validation, graph validation, or effect props invalid (error in [graph_validation_failed, effect_props_invalid]).

application/json

object

error

required

string

message

string

errors

Array<string>

issues

Array<object>

object

key

additional properties

any

draftId

string

key

additional properties

any

Example^generated

1
{
2
  "error": "example",
3
  "message": "example",
4
  "errors": [
5
    "example"
6
  ],
7
  "issues": [
8
    {}
9
  ],
10
  "draftId": "example"
11
}

PUT

/api/projects/{projectId}/automations/{id}/definition

1
curl --request PUT \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/definition \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "definition": {
7
    "nodes": [
8
      {}
9
    ]
10
  },
11
  "validateOnly": true
12
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/definition';
2
const options = {
3
  method: 'PUT',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"definition":{"nodes":[{}]},"validateOnly":true}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/definition"
4

5
payload = {
6
    "definition": { "nodes": [{}] },
7
    "validateOnly": True
8
}
9
headers = {
10
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
11
    "Content-Type": "application/json"
12
}
13

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

16
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/definition"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"definition\": {\n    \"nodes\": [\n      {}\n    ]\n  },\n  \"validateOnly\": true\n}")
9

10
response = httpx.put(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/definition"
13

14
  payload := strings.NewReader("{\n  \"definition\": {\n    \"nodes\": [\n      {}\n    ]\n  },\n  \"validateOnly\": true\n}")
15

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

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

200Draft saved (existing draft updated) or { valid:true } for validateOnly.

1
{
2
  "status": "draft"
3
}

Save draft version (or validate-only for import gate)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

201

Example

400

Examplegenerated

403

Examplegenerated

404

Examplegenerated

422

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated