v1

latestOpenAPI 3.1.02026-07-22750642.5 KB

Journeys

Set trigger

Configure how people enter the journey by updating its ENTRY node: manual, segment (needs segmentId), or cdp_event (needs eventName), with an optional frequency cap.

patch/api/v1/journeys/{journeyId}/trigger

Path parameters

journeyIdstring required

A draft journey id, or the initiative id (resolves to its current draft).

Request body

triggerType'manual' | 'segment' | 'cdp_event' required

How people enter the journey.

segmentIdstring

Required for segment triggers.

segmentNamestring

eventNamestring

Required for cdp_event triggers.

maxEnrollmentsinteger

Frequency cap; both-or-neither with enrollmentWindow.

enrollmentWindowstring

Frequency-cap window, e.g. '7d'.

Response

Success

idstring required

Journey (workflow version) id.

initiativeIdstring required

The initiative this journey belongs to.

status'DRAFT' | 'PUBLISHED' | 'STOPPED' required

DRAFT (editable), PUBLISHED (live, frozen), or STOPPED (retired).

versioninteger required

Version number within the initiative.