Pause an enrollment

POST /api/v1/enrollments/{enrollmentId}/pause

Interrupts one participation without erasing anything: history, path and future rights stay in place. You choose what happens to deadlines and to the member's access while the pause lasts, and both choices are made here — not when the enrollment resumes. Reminders for the current action, automatic recalculation of the next action and presence in the work queue stop until then. No other enrollment is affected.

Authorization

Organization role

Business authorization

Interrupting a participation decides someone's access to the product, so it is an operating decision: a coach assigned to the enrollment can document sessions and plan interventions, but cannot pause. A platform-wide role grants nothing here. An enrollment of another organization is refused without revealing whether it exists.

Path parameters

Request headers

Request body

deadlinePolicy decides what happens when the enrollment resumes:

• shift — relative deadlines, the current action, open blockers and planned interventions all move forward by the length of the pause;
• keep — nothing moves, and delays accumulate.

accessPolicy decides what the member can still do:

• read_only — the member can re-read lessons; deliverables, completions and blockers are refused with a message that names the pause;
• suspended — the program leaves the member's view until the enrollment resumes.

Both policies refuse the same writes. Only reading differs.

{
  "reason": "Sick leave for three weeks.",
  "effectiveAt": "2026-08-20T09:00:00.000Z",
  "deadlinePolicy": "shift",
  "accessPolicy": "read_only"
}

Example

curl -X POST "$COHORTE_API_BASE_URL/api/v1/enrollments/ENROLLMENT_ID/pause" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Idempotency-Key: pause-2026-08-20" \
  -H 'Content-Type: application/json' \
  -d '{"reason":"Sick leave for three weeks.","deadlinePolicy":"shift","accessPolicy":"read_only"}'

Response

• 201 Created — the participation is paused.
• 200 OK — the same Idempotency-Key replayed the original pause.
• 400 Bad Request — missing Idempotency-Key, invalid JSON, an empty reason, an unknown policy, an effective date in the future, or an enrollment that is not active.
• 401 Unauthorized — the key is missing, invalid, or no longer attached to a member.
• 403 Forbidden — the bearer cannot change the lifecycle of enrollments in this organization.
• 404 Not Found — the enrollment is unknown or belongs to another organization.

Response fields

Example response

{
  "success": true,
  "replayed": false,
  "data": {
    "id": "9f2c0a1e-0000-4000-8000-000000000000",
    "enrollmentId": "4af4cd8d-0000-4000-8000-000000000000",
    "reason": "Sick leave for three weeks.",
    "effectiveAt": "2026-08-20T09:00:00.000Z",
    "deadlinePolicy": "shift",
    "accessPolicy": "read_only",
    "pausedBy": "6d41ab55-0000-4000-8000-000000000000",
    "pausedByName": "Paul Vidal",
    "pausedByActorType": "human",
    "reactivatedAt": null,
    "reactivatedBy": null,
    "reactivatedByName": null,
    "shiftDays": 0,
    "resumeNote": null,
    "createdAt": "2026-08-20T09:00:05.000Z"
  },
  "correlationId": "0f6b1d92-0000-4000-8000-000000000000"
}

Agent recipe

1. Confirm the enrollment is active — only an active participation can be paused.
2. Pause it with a reason your team will read later, and the two policies that match the situation.
3. Resume it with the companion endpoint when the member comes back.

Notes

• Retrying with the same Idempotency-Key returns the original pause and opens no second period, audit entry or event.
• One enrollment has at most one open pause at a time.
• Fixed program dates are never moved, under either policy: they are shared by everyone enrolled in the program, and moving one for a single member would move it for the whole cohort. An individual extension is a separate capability.
• effectiveAt — not the recording time — is what dates the pause and what the shift is counted from. Backdating an interruption that already started is the normal case.
• The pause, its audit entry and the enrollment.paused event are written in one transaction, together with the cancellation of the current action's reminder.
• No email or notification is sent by this endpoint.

Related

• Resume an enrollment
• Read an enrollment timeline
• Plan an intervention