Skip to main content

cohorts.delete

Delete a cohort nobody has ever been in

Request
DELETE/api/v1/organizations/{organizationSlug}/cohorts/{cohortId}
Scope required
organizations:write
Effect
Deletes something. Confirm with a person before calling it.
Acts on
Acts on an organization, and names it in the path.
MCP tool
cohorts_delete
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Deletes a cohort created by mistake. Only a cohort nobody has ever been placed in can be deleted, because deleting one would take the record of everyone's time in it along with it; anything else is refused with 409 in favour of `cohorts.update` with `archived: true`, which is almost always what was meant. Owners and admins may call it. Answers 204 with no body.

Parameters

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

Response

Answers 204 with no body.

Examples

Remove a cohort created by mistake

Remove a cohort created by mistake — request
curl -s -X DELETE https://www.jobapplicationtracking.com/api/v1/organizations/northside-career-center/cohorts/coh_12 \
  -H "Authorization: Bearer $JAT_KEY"
Remove a cohort created by mistake — response
null

Related operations