Create a journey
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
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.
apiKeyheader
x-api-key<token>application/json- body
name*JourneyNameMatch
^\S[\s\S]*\S$|^\S$|^$Length
1 <= length <= 200definition*Journey
application/json- response
id*JourneyIdMatch
^jrny_[0-9a-hjkmnp-tv-z]{16,24}$name*stringstatus*JourneyStatusValue in
"draft""active""paused""archived"revision*stringdraft*publishedVersion*|nullpublishedAt*string|nullcreatedAt*stringupdatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.journeys.create({
"name": "example",
"definition": {
"trigger": {
"type": "event",
"eventName": "example"
},
"rootNodeId": "example",
"nodes": {}
}
});Example Response
{
"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"
}