Skip to content

Tool

enroll_in_journey

Enroll contact in journey

Idempotent
SurfacesChat agentMCPCLI

Enroll a contact into an api_event journey by contact id or email — the manual trigger. The journey must be active. Ledger-safe: it only enrolls (the send happens on the next scheduler tick). A non-reentrant duplicate is a no-op (enrolled:false).

CLI: tinbox enroll-in-journey

Parameters

NameTypeRequiredDescription
journeyIdstringyesThe journey to enroll the contact into.
contactIdstringnoThe contact id (provide this or `email`).
emailstringnoThe contact's email (resolved to a contact).

Example

json
{
  "journeyId": "<journeyId>"
}