Zum Inhalt springen
Docs
Deutsch
Esc
navigateopen⌘Jpreview

Update a curricula version

Partial update of version fields (name, version, isDefault). Returns summary fields — use GET /curricula/{id}/versions/{versionId} for full structure. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/curricula/{id}/versions/{versionId}
Path parameters
idstringrequired
versionIdstringrequired
Request body
requiredapplication/json
namestring
versionstring
isDefaultboolean
Responses
200Updated version
dataCurriculaVersionrequired
Curriculum version summary. Returned by list endpoints; GET-by-ID expands nested relations via CurriculaVersionDetail.
Show properties
idstringrequired
versionstringrequired
namestringrequired
curriculaIdstringrequired
isDefaultbooleanrequired
isCohortVersionbooleanrequired
sourceCohortIdstring | null
electionModestring | null
When students may elect modules. Null when election is not configured.
Allowed:ELECT_WHENEVERELECT_BEFORE_TERMELECT_AFTER_TERM
electionStartWeeksinteger | null
Weeks before term when election opens.
electionEndWeeksinteger | null
Weeks before term when election closes.
createdAtstring<date-time>required
updatedAtstring<date-time>required
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
400Bad 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
401Unauthorized
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
404Not 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
429Too 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
500Internal 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
Request
curl -X PATCH "https://fuxam.app/api/v4/curricula/string/versions/string" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "version": "string",
  "isDefault": true
}'
Response
{
  "data": {
    "id": "cv_001",
    "version": "1.0",
    "name": "Default",
    "curriculaId": "cur_001",
    "isDefault": true,
    "isCohortVersion": false,
    "sourceCohortId": "string",
    "electionMode": "ELECT_WHENEVER",
    "electionStartWeeks": 0,
    "electionEndWeeks": 0,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}