Journeys Enrollment

Tags: journeys, members

Enroll, unenroll, and re-enroll members in journeys

Endpoints

• GET /api/v2/w/{workspace_uuid}/journeys/by-member/{member_id} - By Member
• POST /api/v2/w/{workspace_uuid}/journeys/{journey_id}/enroll - Enroll
• GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}/members - Members
• DELETE /api/v2/w/{workspace_uuid}/journeys/{journey_id}/members/{member_id} - Delete Members
• POST /api/v2/w/{workspace_uuid}/journeys/{journey_id}/reenroll - Reenroll
• POST /api/v2/w/{workspace_uuid}/journeys/{journey_id}/unenroll - Unenroll

By Member

GET /api/v2/w/{workspace_uuid}/journeys/by-member/{member_id}

Description:

Get journey enrollments for a member (most recent first).

Capped at 200 enrollments until server-side pagination is added in a follow-up PR (tracked by #10014). The adjacent /journeys/\{journey_id}/members endpoint uses the same ceiling.

Authorization: Requires journeys:read scope

Parameters:

• member_id (Integer)

Response: List of MemberJourneyResponse

---

Enroll

POST /api/v2/w/{workspace_uuid}/journeys/{journey_id}/enroll

Description:

Enroll one or more members in a journey.

Authorization: Requires journeys:write scope

Parameters:

• journey_id (Integer)
• request - See EnrollMemberRequest

Response: List of MemberJourneyResponse

---

Members

GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}/members

Description:

List enrolled members and their progress for a journey (paginated).

Authorization: Requires scopes: journeys:read, members:read

Parameters:

• journey_id (Integer)
• page (Integer) — min: 1
• pageSize (Integer) — min: 1, max: 200
• search (String)
• status (String)
• enrolled_after (datetime)
• enrolled_before (datetime)
• current_task_id (Integer)
• runtime_failure_edge_id (Integer)

Response: See PaginatedResponse[MemberJourneyResponse]

---

Delete Members

DELETE /api/v2/w/{workspace_uuid}/journeys/{journey_id}/members/{member_id}

Description:

Hard-delete a canceled or completed enrollment so the member can be re-enrolled fresh.

Authorization: Requires journeys:admin scope

Parameters:

• journey_id (Integer)
• member_id (Integer)

---

Reenroll

POST /api/v2/w/{workspace_uuid}/journeys/{journey_id}/reenroll

Description:

Re-enroll a canceled or completed member back to enrolled status.

Authorization: Requires journeys:write scope

Parameters:

• journey_id (Integer)
• request - See ReenrollMemberRequest

Response: See MemberJourneyResponse

---

Unenroll

POST /api/v2/w/{workspace_uuid}/journeys/{journey_id}/unenroll

Description:

Unenroll one or more members from a journey.

Authorization: Requires journeys:write scope

Parameters:

• journey_id (Integer)
• request - See UnenrollMemberRequest

Response: List of MemberJourneyResponse

---