cohorts.update
Rename a cohort, archive it, or reopen it
- Request
- PATCH
/api/v1/organizations/{organizationSlug}/cohorts/{cohortId} - 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
cohorts_update- Environment
- Live and sandbox alike.
- Request body
- JSON.
What it does
Changes the fields you name and leaves the rest alone. `archived: true` closes the cohort to new applicants while keeping every record of who was in it — nobody is removed — and `archived: false` reopens it. Archiving is almost always what you want instead of `cohorts.delete`, which refuses any cohort somebody has been in. A name another cohort in this organization already holds is refused with 409. Owners and admins may call it.
Parameters
| Name | Sent in | Requirement | Accepts |
|---|---|---|---|
| organizationSlug | path | Required | string |
| cohortId | path | Required | string |
Request body
- archived
- boolean, optional
- name
- string, optional
Response
- archivedAt
- string or null, required
- createdAt
- string, required
- id
- string, required
- name
- string, required
Examples
Rename the spring intake
curl -s -X PATCH https://www.jobapplicationtracking.com/api/v1/organizations/northside-career-center/cohorts/coh_12 \
-H "Authorization: Bearer $JAT_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Spring 2026 intake"
}'{
"id": "coh_12",
"name": "Spring 2026 intake",
"archivedAt": null,
"createdAt": "2026-01-06T12:00:00.000Z"
}