Update a module

Partial update of module fields (name, code). Returns the updated module without nested versions. Use GET /modules/{id} for full detail. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/modules/{id}

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

Request body

requiredapplication/json

namestring

codestring

Responses

200

Updated module

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

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

404

Not 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

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

idpath*

Bodyapplication/json

namestringcodestring

Request

curl -X PATCH 'https://fuxam.app/api/v4/modules/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Introduction to Economics",
  "code": "ECON-101"
}'

const response = await fetch("https://fuxam.app/api/v4/modules/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Introduction to Economics\",\n  \"code\": \"ECON-101\"\n}"
});

import requests

response = requests.patch(
    "https://fuxam.app/api/v4/modules/string",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Introduction to Economics\",\n  \"code\": \"ECON-101\"\n}",
)

Response

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