Close an enrollment

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

Records how one participation ended. Closing is final: it fixes the real outcome and prepares what comes next. The history stays intact and stays readable to the member according to the access policy you pick. The current action and its reminder are cancelled, planned interventions are closed, an open pause is ended. No other enrollment is affected.

Authorization

Organization role

Business authorization

Closing is wider than pausing, and deliberately so: interrupting a participation decides someone's access to the product, while stating that it ended — and writing the summary — is the gesture of whoever accompanied it. 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

result decides which transition is allowed:

• an active or paused enrollment can be closed with any of the three;
• a pending enrollment can only be cancelled — a participation that never started can neither have completed nor stopped along the way;
• an already closed enrollment cannot be closed again.

accessPolicy decides what the member can still read:

• read_only — the member re-reads their journey and history; they no longer write;
• suspended — the journey leaves the member's view. Their account remains.

Both policies refuse the same writes. Only reading differs.

Closing does not require any completion rate. A completion states the real outcome, not a percentage of lessons.

{
  "result": "completed",
  "reason": "Commercial objective reached, final call done.",
  "outcomeAchieved": true,
  "summary": "Six clients signed over the period, two of them recurring.",
  "nextRecommendation": "Scale program next quarter.",
  "accessPolicy": "read_only"
}

Example

curl -X POST "$COHORTE_API_BASE_URL/api/v1/enrollments/ENROLLMENT_ID/close" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Idempotency-Key: close-2026-09-03" \
  -H 'Content-Type: application/json' \
  -d '{"result":"completed","reason":"Commercial objective reached.","outcomeAchieved":true,"summary":"Six clients signed.","accessPolicy":"read_only"}'

Response

• 201 Created — the participation is closed.
• 200 OK — the same Idempotency-Key replayed the original closure.
• 400 Bad Request — missing Idempotency-Key, invalid JSON, an empty reason, an unknown result or policy, a completion without outcomeAchieved or summary, one of those fields sent with another result, a final milestone outside the program's primary path, or a pending enrollment closed with something other than cancelled.
• 401 Unauthorized — the key is missing, invalid, or no longer attached to a member.
• 403 Forbidden — the bearer cannot close this enrollment.
• 404 Not Found — the enrollment is unknown or belongs to another organization.
• 409 Conflict — the enrollment is already closed.

Response fields

Example response

{
  "success": true,
  "replayed": false,
  "data": {
    "id": "8b71f4c3-0000-4000-8000-000000000000",
    "enrollmentId": "4af4cd8d-0000-4000-8000-000000000000",
    "result": "completed",
    "reason": "Commercial objective reached, final call done.",
    "outcomeAchieved": true,
    "summary": "Six clients signed over the period, two of them recurring.",
    "nextRecommendation": "Scale program next quarter.",
    "finalMilestoneId": null,
    "finalMilestoneTitle": null,
    "accessPolicy": "read_only",
    "closedBy": "6d41ab55-0000-4000-8000-000000000000",
    "closedByName": "Paul Vidal",
    "closedAt": "2026-09-03T09:00:00.000Z",
    "createdAt": "2026-09-03T09:00:00.000Z"
  },
  "correlationId": "0f6b1d92-0000-4000-8000-000000000000"
}

Agent recipe

1. Read the enrollment state — a closed enrollment cannot be closed again, and a pending one can only be cancelled.
2. Close it with the result that matches what happened, a reason your team will read later, and the access policy the member should keep.
3. For a completion, state whether the objective was reached and write the summary; both are required, and both stay internal.
4. Put anything the member should read next in nextRecommendation.

Notes

• Retrying with the same Idempotency-Key returns the original closure and writes no second record, audit entry, event or cancellation.
• One enrollment has at most one closure. Closing is final: there is no reopen endpoint, and re-enrolling the same person creates a new enrollment.
• The reason and the summary are written by your team, for your team. The member sees the result, the date and nextRecommendation — never those two texts.
• Closing does not move the person to alumni, renew anything, or sell a new offer. Those remain separate decisions.
• A closed enrollment does not block a new enrollment of the same person on the same program.
• The closure, its audit entry and the enrollment.closed event are written in one transaction, together with the cancellation of the current action and its reminder, the closing of planned interventions, and the end of an open pause.
• An open blocker stays open: a coach can still resolve it after the closure.
• Fixed program dates and the accumulated pause shift are never changed.
• No email or notification is sent by this endpoint.

Related

• Pause an enrollment
• Resume an enrollment
• Read an enrollment timeline