Skip to Content

Journeys

Event-triggered, per-contact email flows defined as versioned node graphs. 14 endpoints under /v1/journeys.

Endpoints

EndpointWhat it does
GET /v1/journeysList journeys
POST /v1/journeysCreate a journey
DELETE /v1/journeys/{id}Delete a journey
GET /v1/journeys/{id}Get a journey
PATCH /v1/journeys/{id}Rename a journey
POST /v1/journeys/{id}/archiveArchive a journey
PUT /v1/journeys/{id}/draftReplace a journey draft
POST /v1/journeys/{id}/pausePause a journey
POST /v1/journeys/{id}/publishPublish a journey
POST /v1/journeys/{id}/resumeResume a journey
GET /v1/journeys/{id}/runsList journey runs
GET /v1/journeys/{id}/runs/{runId}Get a journey run
GET /v1/journeys/{id}/statsGet journey run counts
GET /v1/journeys/{id}/versions/{version}Get a published journey version

Base URL, authentication, errors, and pagination are the same for every endpoint; see the REST API reference.

Related documentation

On this page