Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Journeys

Create a journey (Preview)

Preview · Available to selected organizations. Creates a draft journey from a definition: a trigger, a root node, and a graph of at most 200 nodes that is acyclic and fully reachable.

POST
/v1/journeys

Creates a draft journey from a definition: a trigger, a root node, and a graph of at most 200 nodes that is acyclic and fully reachable. Templates, senders, and groups the definition names must belong to the organization. Requires a plan that includes journeys.

Authorization

apiKey
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*JourneyName
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 200
definition*

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/journeys" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "definition": {      "trigger": {        "type": "event",        "eventName": "string"      },      "rootNodeId": "string",      "nodes": {        "property1": {          "type": "send_email",          "config": {            "template": "string"          },          "next": [            {              "nodeId": "string"            }          ]        },        "property2": {          "type": "send_email",          "config": {            "template": "string"          },          "next": [            {              "nodeId": "string"            }          ]        }      }    }  }'
{  "id": "string",  "name": "string",  "status": "draft",  "revision": "string",  "draft": {    "trigger": {      "type": "event",      "eventName": "string"    },    "rootNodeId": "string",    "nodes": {      "property1": {        "type": "send_email",        "config": {          "template": "string",          "senderId": "string",          "templateData": {            "property1": "string",            "property2": "string"          }        },        "next": [          {            "nodeId": "string"          }        ]      },      "property2": {        "type": "send_email",        "config": {          "template": "string",          "senderId": "string",          "templateData": {            "property1": "string",            "property2": "string"          }        },        "next": [          {            "nodeId": "string"          }        ]      }    },    "goal": {      "eventName": "string"    },    "reentry": true  },  "publishedVersion": -9007199254740991,  "publishedAt": "string",  "createdAt": "string",  "updatedAt": "string"}

Related documentation

Archive a journey (Preview)

Preview · Available to selected organizations. Stops new enrollment for good and exits every live run with exit reason archived. An archived journey cannot be edited, published, or resumed.

Get a journey (Preview)

Preview · Available to selected organizations. Returns a journey with its draft definition, its current revision, and its newest published version number.