Skip to main content

cohort_memberships.end

End an applicant's time in a cohort

Request
POST/api/v1/organizations/{organizationSlug}/cohort-memberships/{membershipId}/end
Scope required
organizations:write
Effect
Changes data. Send an Idempotency-Key if you might retry it.
Acts on
Acts on an organization, and names it in the path.
MCP tool
cohort_memberships_end
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Closes a stint, on the record, with a reason. Nothing is deleted: the row stays and gains a leaving date, so the same applicant can be placed in the same cohort again later and both stints stand. The reason is required because "no longer in it" is the least useful thing a career centre can record — `completed`, `placed`, `withdrew` and `removed` are the whole difference between the four people it describes. Owners and admins may call it; a stint that is already closed is refused. Placing the same applicant in the same cohort again is `cohort_memberships.create`.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
NameSent inRequirementAccepts
organizationSlugpathRequiredstring
membershipIdpathRequiredstring

Request body

departureReason
one of: completed, placed, withdrew, removed, required
note
string or null, optional

Response

applicantEmail
string, required
cohortId
string, required
departureReason
one of: completed, placed, withdrew, removed or null, required
id
string, required
joinedAt
string, required
leftAt
string or null, required
note
string or null, required

Examples

A student finishes the programme

A student finishes the programme — request
curl -s -X POST https://www.jobapplicationtracking.com/api/v1/organizations/northside-career-center/cohort-memberships/cm_87/end \
  -H "Authorization: Bearer $JAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "departureReason": "completed"
}'
A student finishes the programme — response
{
  "id": "cm_87",
  "cohortId": "coh_12",
  "applicantEmail": "student@northside.example",
  "joinedAt": "2026-01-06T12:00:00.000Z",
  "leftAt": "2026-06-30T17:00:00.000Z",
  "departureReason": "completed",
  "note": null
}

Related operations