Create a curriculum
Creates a curriculum with an initial version. Returns the created curriculum with versions[]. Optionally attach modules via moduleIds. Connect curricula to a study program with curriculaIds on POST /study-programs (or PATCH). Use GET /curricula/{id} for full structure. Scoped to your integration’s institution via Basic Auth credentials.
POST
/curriculaHeader parameters
Idempotency-KeystringrequiredRequest body
requiredapplication/jsonnamestringrequiredcodestringinitialVersionNamestringmoduleIdsstring[]Optional module IDs to attach to the initial version.
Responses
201Curriculum created
dataCurriculaCreateResultrequiredCurriculum returned by POST /curricula: created curriculum with its initial version. Use GET /curricula/{id} for full structure and module items.
Show propertiesHide properties
versionsCurriculaVersion[]requiredShow propertiesHide properties
Array of
CurriculaVersionidstringrequiredversionstringrequirednamestringrequiredcurriculaIdstringrequiredisDefaultbooleanrequiredisCohortVersionbooleanrequiredsourceCohortIdstring | nullelectionModestring | nullWhen students may elect modules. Null when election is not configured.
Allowed:
ELECT_WHENEVERELECT_BEFORE_TERMELECT_AFTER_TERMelectionStartWeeksinteger | nullWeeks before term when election opens.
electionEndWeeksinteger | nullWeeks before term when election closes.
createdAtstring<date-time>requiredupdatedAtstring<date-time>requiredstudyProgramConnectedCurriculaobject[]idstringrequirednamestringrequiredinstitutionIdstringrequiredcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredisCohortSpecificbooleanrequiredisArchivedboolean | nullcodestring | nullmetaResponseMetarequiredShow propertiesHide properties
requestIdstringrequiredtimestampstring<date-time>requiredversionstringrequiredAllowed:
v4400Bad Request
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring401Unauthorized
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring409Conflict
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 POST "https://fuxam.app/api/v4/curricula" \
-H "Idempotency-Key: string" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"code": "string",
"initialVersionName": "string",
"moduleIds": [
"string"
]
}'const response = await fetch("https://fuxam.app/api/v4/curricula", {
method: "POST",
headers: {
"Idempotency-Key": "string",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "string",
"code": "string",
"initialVersionName": "string",
"moduleIds": [
"string"
]
})
});import requests
response = requests.post(
"https://fuxam.app/api/v4/curricula",
headers={
"Idempotency-Key": "string",
"Content-Type": "application/json"
},
json={
"name": "string",
"code": "string",
"initialVersionName": "string",
"moduleIds": [
"string"
]
},
)Response
{
"data": {
"id": "cur_001",
"name": "Bachelor CS 2024",
"institutionId": "inst_123",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-06-01T00:00:00.000Z",
"isCohortSpecific": false,
"isArchived": false,
"code": "CS-2024",
"versions": [
{
"id": "cv_001",
"version": "1.0",
"name": "Default",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-06-01T00:00:00.000Z",
"curriculaId": "cur_001",
"electionEndWeeks": null,
"electionMode": null,
"electionStartWeeks": null,
"isCohortVersion": false,
"sourceCohortId": null
}
],
"studyProgramConnectedCurricula": []
},
"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"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}