Create a module

Creates a module with an initial active version. Returns the created module with defaultVersion, firstVersion, and courses count. Use GET /modules/{id} for examination requirements, files, and full version detail. Scoped to your integration’s institution via Basic Auth credentials.

POST/modules

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Header parameters

Idempotency-Keystringrequired

Request body

requiredapplication/json

namestringrequired

codestring

descriptionstring

iconstring

bannerstring

ectsPointsinteger

requiredAttendancePercentageinteger

versionNamestring

Responses

201

Module created

dataModuleCreateResultrequired

Module returned by POST /modules: created module with its initial version, plus defaultVersion, firstVersion, and courses count. Use GET /modules/{id} for examination requirements, files, and full version detail.

Show properties

idstringrequired

namestringrequired

institutionIdstringrequired

codestring | null

isArchivedboolean | null

nameTranslationsobject | null

courseModuleTagsModuleTag[]

Show properties

Array of ModuleTag

idstringrequired

courseModuleIdstringrequired

tagIdstringrequired

tagobjectrequired

Show properties

idstringrequired

namestringrequired

institutionIdstringrequired

colorstring | null

iconstring | null

versionsModuleVersion[]required

Show properties

Array of ModuleVersion

idstringrequired

versionstringrequired

namestringrequired

descriptionstring | nullrequired

May be an empty string when not set.

iconstring | nullrequired

iconTypestring | nullrequired

bannerstring | nullrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

requiredAttendancePercentageintegerrequired

ectsPointsintegerrequired

courseModuleIdstringrequired

statusstringrequired

Allowed:DRAFTACTIVEARCHIVED

timePlanIdstring | nullrequired

isDefaultbooleanrequired

earlyAssessmentEnabledbooleanrequired

isCurrentlyElectablebooleanrequired

capacityinteger | nullrequired

colorinteger | nullrequired

courseChatFileAttachmentsDefaultbooleanrequired

courseChatReadOnlyDefaultbooleanrequired

courseFeatureDefaultsobject | nullrequired

moduleNamestring | nullrequired

attemptRulesobject | nullrequired

defaultVersionModuleVersion | null

The default version for this module. On create, matches firstVersion.

Show properties

Any of:

ModuleVersion

idstringrequired

versionstringrequired

namestringrequired

descriptionstring | nullrequired

May be an empty string when not set.

iconstring | nullrequired

iconTypestring | nullrequired

bannerstring | nullrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

requiredAttendancePercentageintegerrequired

ectsPointsintegerrequired

courseModuleIdstringrequired

statusstringrequired

Allowed:DRAFTACTIVEARCHIVED

timePlanIdstring | nullrequired

isDefaultbooleanrequired

earlyAssessmentEnabledbooleanrequired

isCurrentlyElectablebooleanrequired

capacityinteger | nullrequired

colorinteger | nullrequired

courseChatFileAttachmentsDefaultbooleanrequired

courseChatReadOnlyDefaultbooleanrequired

courseFeatureDefaultsobject | nullrequired

moduleNamestring | nullrequired

attemptRulesobject | nullrequired

null

null

firstVersionModuleVersion | null

The first version created for this module.

Show properties

Any of:

ModuleVersion

idstringrequired

versionstringrequired

namestringrequired

descriptionstring | nullrequired

May be an empty string when not set.

iconstring | nullrequired

iconTypestring | nullrequired

bannerstring | nullrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

requiredAttendancePercentageintegerrequired

ectsPointsintegerrequired

courseModuleIdstringrequired

statusstringrequired

Allowed:DRAFTACTIVEARCHIVED

timePlanIdstring | nullrequired

isDefaultbooleanrequired

earlyAssessmentEnabledbooleanrequired

isCurrentlyElectablebooleanrequired

capacityinteger | nullrequired

colorinteger | nullrequired

courseChatFileAttachmentsDefaultbooleanrequired

courseChatReadOnlyDefaultbooleanrequired

courseFeatureDefaultsobject | nullrequired

moduleNamestring | nullrequired

attemptRulesobject | nullrequired

null

null

coursesinteger

Total courses linked across all versions.

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

409

Conflict

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

Idempotency-Keyheader*

Bodyapplication/json

namestring*codestringdescriptionstringiconstringbannerstringectsPointsintegerrequiredAttendancePercentageintegerversionNamestring

Request

curl -X POST 'https://fuxam.app/api/v4/modules' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "code": "string",
  "description": "string",
  "icon": "string",
  "banner": "string",
  "ectsPoints": 0,
  "requiredAttendancePercentage": 0,
  "versionName": "string"
}'

const response = await fetch("https://fuxam.app/api/v4/modules", {
  method: "POST",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Idempotency-Key": "string",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"code\": \"string\",\n  \"description\": \"string\",\n  \"icon\": \"string\",\n  \"banner\": \"string\",\n  \"ectsPoints\": 0,\n  \"requiredAttendancePercentage\": 0,\n  \"versionName\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://fuxam.app/api/v4/modules",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Idempotency-Key": "string",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"code\": \"string\",\n  \"description\": \"string\",\n  \"icon\": \"string\",\n  \"banner\": \"string\",\n  \"ectsPoints\": 0,\n  \"requiredAttendancePercentage\": 0,\n  \"versionName\": \"string\"\n}",
)

Response

{
  "data": {
    "id": "cm_xyz789",
    "name": "Economics",
    "institutionId": "inst_123",
    "code": "ECO-101",
    "isArchived": false,
    "nameTranslations": null,
    "courseModuleTags": [],
    "versions": [
      {
        "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": true,
        "earlyAssessmentEnabled": false,
        "isCurrentlyElectable": true,
        "capacity": null,
        "color": null,
        "courseChatFileAttachmentsDefault": true,
        "courseChatReadOnlyDefault": false,
        "courseFeatureDefaults": null,
        "moduleName": null,
        "attemptRules": null
      }
    ],
    "defaultVersion": {
      "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": true,
      "earlyAssessmentEnabled": false,
      "isCurrentlyElectable": true,
      "capacity": null,
      "color": null,
      "courseChatFileAttachmentsDefault": true,
      "courseChatReadOnlyDefault": false,
      "courseFeatureDefaults": null,
      "moduleName": null,
      "attemptRules": null
    },
    "firstVersion": {
      "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": true,
      "earlyAssessmentEnabled": false,
      "isCurrentlyElectable": true,
      "capacity": null,
      "color": null,
      "courseChatFileAttachmentsDefault": true,
      "courseChatReadOnlyDefault": false,
      "courseFeatureDefaults": null,
      "moduleName": null,
      "attemptRules": null
    },
    "courses": 0
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00: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"
    }
  ]
}