API
Journeys API
Propose, dry-run, activate, and inspect enrollments.
Journeys are versioned workflow documents. Agents prepare them; you review and approve before activation, in Audryo or directly in your agent chat. An agent with deliver access can carry out your approved launch. Once active, the Journey sends automatically under its rules; individual deliveries need no further human approval.
Create / edit: createWorkflowProposal, getWorkflow, reviseWorkflow, deleteWorkflow, listWorkflowVersions, restoreWorkflowVersion Review / run: reviewWorkflow, runWorkflowDryRun, getWorkflowRuntime, updateWorkflowRuntime Enrollments: listWorkflowEnrollments, createWorkflowEnrollment
Scope: write to propose and revise; deliver to review-approve and activate; read for get/list/runtime.
Proposal, not live
createWorkflowProposal returns approvalStatus in review. A 201 is not “the Journey is sending.” Track status. There is no force: true.
The specification graph includes entry/entries, nodes (email, delay, wait_until, branch, experiment, set_attribute, set_tag, webhook, exit), holdout percentage, goal, and frequency cap.
Description and intended outcome
Always fill specification.objective with a plain-language description of who enters, what the Journey does, and what it should achieve (10–2,000 characters). This is the Description & goal field in the interface, not an internal planner note. For example:
Welcome new free-plan users, guide them through setup, and help them create their first project within seven days. Stop follow-ups once setup is complete.
getWorkflow and getWorkflowContext return this text in specification.objective. Send it inside the specification when creating a structured proposal or calling reviseWorkflow. Keep it current when the Journey's purpose changes, and preserve it otherwise. Versions and restores retain the corresponding description. specification.goal.event remains the separate confirmed event used to measure conversion.
Locales
After the structure exists, every email node needs a confirmed message document per enabled locale (createMessageProposal / reviseMessageDocument). Dry run fails closed if a locale is missing.
Dry run and activate
runWorkflowDryRun— no mail leaves.- After the user reviews and explicitly approves the Journey,
reviewWorkflow(approve). The user can approve in their agent chat; an agent withdeliveraccess can perform this operation on their behalf. - Runtime
updateWorkflowRuntime/ activate (deliverscope).
CLI: audryo journeys list | inspect | activate. MCP: list_journeys and activate tools. Live projects need a verified sending identity to activate; sandbox projects can activate right away and capture every email. In sandbox, fastForwardWorkflow makes waiting enrollments due now.
Enrollments
createWorkflowEnrollment is for explicit, idempotent enroll (with Idempotency-Key). Most production enrollments happen from event ingest or audience entry, not this call.
Statuses include scheduled, active, holdout, blocked, and exit reasons such as goal_reached.