Invoke a journey
Starts a journey run for one user and returns a runId. Runs execute asynchronously, so the response arrives before any message is sent.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A unique identifier representing the journey to be invoked. Accepts a Journey ID or Journey Alias.
Body
Request body for invoking a journey. Requires either a user identifier or a profile with contact information. User identifiers can be provided via user_id field, or resolved from profile/data objects (user_id, userId, or anonymousId fields).
A unique identifier for the user. If not provided, the system will attempt to resolve the user identifier from profile or data objects.
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.
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
A unique identifier for the journey run that was created.