Sign in
Journeys

Invoke a journey

Invoke a journey by id or alias to start a new run. The response includes a runId identifying the run.

post/journeys/{templateId}/invoke

Path parameters

templateIdstring required

A unique identifier representing the journey to be invoked. Accepts a Journey ID or Journey Alias.

Request body

user_idstring

A unique identifier for the user. If not provided, the system will attempt to resolve the user identifier from profile or data objects.

profileobject

Profile data for the user. Can contain contact information (email, phone_number), user identifiers (user_id, userId, anonymousId), or any custom profile fields. Profile fields are merged with any existing stored profile for the user. Include context.tenant_id to load a tenant-scoped profile for multi-tenant scenarios.

dataobject

Data payload passed to the journey. The expected shape can be predefined using the schema builder in the journey editor. This data is available in journey steps for condition evaluation and template variable interpolation. Can also contain user identifiers (user_id, userId, anonymousId) if not provided elsewhere.

Response

Journey invocation accepted

runIdstring required

A unique identifier for the journey run that was created.

Changes