Skip to main content
POST
/
api
/
v1
/
public
/
journeys
/
{id}
/
trigger
Trigger a journey for a recipient
curl --request POST \
  --url http://localhost:3001/api/v1/public/journeys/{id}/trigger \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "recipient": {
    "email": "jsmith@example.com",
    "userId": "<string>",
    "anonymousId": "<string>"
  },
  "variables": {}
}
'
{
  "runId": "<string>",
  "workflowId": "<string>",
  "status": "queued"
}

Documentation Index

Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

Journey ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
​
recipient
object
required
​
variables
object

Response

Default Response

​
runId
string
required
​
workflowId
string
required
​
status
enum<string>
required
Available options:
queued,
running,
completed,
failed,
exited