Create a module version
Creates a new version for an existing module. Pass versionName in the body (e.g. 1.0, 2.0). The default course title is copied from the parent module; optionally pass moduleDisplayName to override how the module is displayed for this version. Returns summary fields — use GET /modules/{id}/versions/{versionId} for full detail. Scoped to your integration’s institution via Basic Auth credentials.
POST
/modules/{id}/versionsPath parameters
idstringrequiredHeader parameters
Idempotency-KeystringrequiredRequest body
requiredapplication/jsonversionNamestringrequiredVersion label displayed in the UI (e.g. `1.0`, `2.0`). Stored in `CourseModuleVersion.version`.
descriptionstringOptional version description.
moduleDisplayNamestringOptional per-version module display name override (`CourseModuleVersion.moduleName`). When omitted, the parent module name is used.
Responses
201Version created
dataModuleVersionrequiredModule version summary. List and create endpoints return these fields; GET by ID includes nested relations.
Show propertiesHide properties
idstringrequiredversionstringrequirednamestringrequireddescriptionstring | nullrequiredMay be an empty string when not set.
iconstring | nullrequirediconTypestring | nullrequiredbannerstring | nullrequiredcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredrequiredAttendancePercentageintegerrequiredectsPointsintegerrequiredcourseModuleIdstringrequiredstatusstringrequiredAllowed:
DRAFTACTIVEARCHIVEDtimePlanIdstring | nullrequiredisDefaultbooleanrequiredearlyAssessmentEnabledbooleanrequiredisCurrentlyElectablebooleanrequiredcapacityinteger | nullrequiredcolorinteger | nullrequiredcourseChatFileAttachmentsDefaultbooleanrequiredcourseChatReadOnlyDefaultbooleanrequiredcourseFeatureDefaultsobject | nullrequiredmoduleNamestring | nullrequiredattemptRulesobject | nullrequiredmetaResponseMetarequiredShow 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
objectfieldstringmessagestring404Not Found
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/modules/string/versions" \
-H "Idempotency-Key: string" \
-H "Content-Type: application/json" \
-d '{
"versionName": "string",
"description": "string",
"moduleDisplayName": "string"
}'const response = await fetch("https://fuxam.app/api/v4/modules/string/versions", {
method: "POST",
headers: {
"Idempotency-Key": "string",
"Content-Type": "application/json"
},
body: JSON.stringify({
"versionName": "string",
"description": "string",
"moduleDisplayName": "string"
})
});import requests
response = requests.post(
"https://fuxam.app/api/v4/modules/string/versions",
headers={
"Idempotency-Key": "string",
"Content-Type": "application/json"
},
json={
"versionName": "string",
"description": "string",
"moduleDisplayName": "string"
},
)Response
{
"data": {
"id": "cmqevazu005pb4pi9zp2zthd1",
"version": "2.0.0",
"name": "Business Administration Basics",
"description": "",
"icon": null,
"iconType": "emoji",
"banner": null,
"createdAt": "2026-06-15T07:04:18.408Z",
"updatedAt": "2026-06-15T07:04:18.408Z",
"requiredAttendancePercentage": 80,
"ectsPoints": 5,
"courseModuleId": "cmqevazrw05p34pi9wv9w3mks",
"status": "ACTIVE",
"timePlanId": "cmqevazr905p14pi9st41ex1w",
"isDefault": false,
"earlyAssessmentEnabled": false,
"isCurrentlyElectable": true,
"capacity": null,
"color": null,
"courseChatFileAttachmentsDefault": true,
"courseChatReadOnlyDefault": false,
"courseFeatureDefaults": null,
"moduleName": null,
"attemptRules": null
},
"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"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}