Create Journey
POST /v2/partner/templates/{template_id}/journeys
Required scopes
partner:journeys:write
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | createJourney |
| Tags | Campaigns |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| template_id * | path | id | |
| — |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| contact_id * | id | UUID v4. |
| deadline_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
Responses
201
Created
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | journey |
| template_id * | id | UUID v4. |
| contact_id * | id | UUID v4. |
| slug * | string | |
| status * | enum (4) | in_progresscompletedreached_deadlinecancelled |
| engagement_state * | state | noneemail_openedmessage_clickedpage_viewedpage_engaged |
| current_page_id | string (uuid) | |
| started_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| completed_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| deadline_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Example request
POST https://api.digitalonboarding.com/v2/partner/templates/{template_id}/journeys
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }