Zum Inhalt springen
Docs
Deutsch
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Update a cohort

Partial update of cohort fields. When updating dates, the effective range (merged with existing values for omitted fields) must have startDate strictly before endDate at minute precision. Cohort dates are compared at minute precision (matching the dashboard). Returns 422 when both fall in the same minute (startDate and endDate must not be in the same minute) or when startDate is after endDate at minute level (startDate must be before endDate). Returns summary fields — use GET for full detail with members and curriculum structure. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/continuing-education/{id}/cohorts/{cohortId}
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters
idstringrequired
cohortIdstringrequired
Request body
requiredapplication/json
namestring
startDatestring<date-time>

Cohort start date. Compared at minute precision (seconds are ignored). Must be strictly before endDate at minute level. If in the same minute as endDate, returns 422 with startDate and endDate must not be in the same minute.

endDatestring<date-time>

Cohort end date. Compared at minute precision (seconds are ignored). Must be strictly after startDate at minute level. If in the same minute as startDate, returns 422 with startDate and endDate must not be in the same minute.

curriculaVersionIdstring
isArchivedboolean
Responses
200

Updated cohort

dataCohortrequired
Show properties
idstringrequired
namestringrequired
institutionIdstringrequired
startDatestring<date-time>required
endDatestring<date-time>required
curriculaVersionIdstringrequired
studyProgramVersionIdstringrequired
isArchivedbooleanrequired
hasDisconnectedFromCurriculaboolean
originalCurriculaVersionIdstring | null
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
400

Bad Request

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
401

Unauthorized

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
404

Not Found

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
422

Unprocessable Entity — validation or business rule error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
429

Too Many Requests

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
500

Internal Server Error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH 'https://fuxam.app/api/v4/continuing-education/string/cohorts/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Cohort 2025",
  "startDate": "2025-09-01T00:00:00.000Z",
  "endDate": "2028-07-31T23:59:59.000Z",
  "isArchived": false
}'
Response
{
  "data": {
    "id": "coh_001",
    "name": "WS 2024/25",
    "institutionId": "inst_123",
    "startDate": "2024-10-01T00:00:00.000Z",
    "endDate": "2027-09-30T00:00:00.000Z",
    "curriculaVersionId": "cv_001",
    "studyProgramVersionId": "spv_001",
    "isArchived": false,
    "hasDisconnectedFromCurricula": false,
    "originalCurriculaVersionId": null
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}