Update a study program version
Renames a study program version. The version to update is identified by the versionId path parameter; the request body accepts optional name (the new display label). To create a version, use POST and pass versionName in the body instead. Returns the updated version with nested cohorts — same shape as GET /study-programs/{id}/versions/{versionId}. Scoped to your integration’s institution via Basic Auth credentials.
PATCH
/study-programs/{id}/versions/{versionId}Path parameters
idstringrequiredversionIdstringrequiredRequest body
requiredapplication/jsonnamestringResponses
200Updated version
dataStudyProgramVersionDetailrequiredStudy program version with nested cohorts. Returned by GET /study-programs/{id}/versions/{versionId}.
Show propertiesHide properties
cohortsCohort[]Show propertiesHide properties
Array of
CohortidstringrequirednamestringrequiredinstitutionIdstringrequiredstartDatestring<date-time>requiredendDatestring<date-time>requiredcurriculaVersionIdstringrequiredstudyProgramVersionIdstringrequiredisArchivedbooleanrequiredhasDisconnectedFromCurriculabooleanoriginalCurriculaVersionIdstring | nullidstringrequirednamestringrequiredinstitutionIdstringrequiredstudyProgramIdstringrequiredisDefaultbooleanrequiredstatisticDataobject | nullmetaResponseMetarequiredShow propertiesHide properties
requestIdstringrequiredtimestampstring<date-time>requiredversionstringrequiredAllowed:
v4401Unauthorized
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring404Not Found
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring429Too Many Requests
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring500Internal Server Error
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestringRequest
curl -X PATCH "https://fuxam.app/api/v4/study-programs/string/versions/string" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'const response = await fetch("https://fuxam.app/api/v4/study-programs/string/versions/string", {
method: "PATCH",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "string"
})
});import requests
response = requests.patch(
"https://fuxam.app/api/v4/study-programs/string/versions/string",
headers={
"Content-Type": "application/json"
},
json={
"name": "string"
},
)Response
{
"data": {
"cohorts": [
{
"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": "string"
}
],
"id": "spv_001",
"name": "2024 Intake",
"institutionId": "inst_123",
"studyProgramId": "sp_abc123",
"isDefault": true,
"statisticData": {}
},
"meta": {
"requestId": "req_1234567890_abc",
"timestamp": "2026-06-02T07:00:00.000Z",
"version": "v4"
}
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}