Archive or unarchive a module

Archive or unarchive a module. Pass operation: archive or unarchive. Returns the updated module row. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/modules/{id}/archive

Path parameters

idstringrequired

Request body

requiredapplication/json

operationstringrequired

Allowed:archiveunarchive

Responses

200Module archived/unarchived

dataModulerequired

Module list item. The `versions` array contains at most one entry (the latest version) with summary fields only.

Show properties

idstringrequired

namestringrequired

institutionIdstringrequired

codestring | null

isArchivedboolean | null

nameTranslationsobject | null

versionsModuleVersion[]

Latest version only (at most one item). Summary fields; no nested exams or files.

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

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

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/modules/string/archive" \
  -H "Content-Type: application/json" \
  -d '{
  "operation": "archive"
}'

const response = await fetch("https://fuxam.app/api/v4/modules/string/archive", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "operation": "archive"
})
});

import requests

response = requests.patch(
    "https://fuxam.app/api/v4/modules/string/archive",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "operation": "archive"
},
)

Response

{
  "data": {
    "id": "cm_xyz789",
    "name": "Economics",
    "institutionId": "inst_123",
    "code": "ECO-101",
    "isArchived": false,
    "nameTranslations": {},
    "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": 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"
    }
  ]
}