Saltar al contenido
Docs
Español
Esc
navigateopen⌘Jpreview

Update a module group

Partial update of a module group. Optionally pass moduleIds to attach modules (default versions). Returns the updated group (same shape as GET). Scoped to your integration’s institution via Basic Auth credentials.

PATCH/module-groups/{id}
Path parameters
idstringrequired
Request body
requiredapplication/json
namestring
codestring
descriptionstring
colorstring
iconstring
moduleIdsstring[]
Optional module IDs to attach (resolved to default versions).
Responses
200Updated module group
dataModuleGrouprequired
Logical grouping of modules used in curricula planning.
Show properties
idstringrequired
namestringrequired
codestring | null
descriptionstring | null
colorstring | null
iconstring | null
institutionIdstringrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
400Bad 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
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/module-groups/string" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "code": "string",
  "description": "string",
  "color": "string",
  "icon": "string",
  "moduleIds": [
    "string"
  ]
}'
Response
{
  "data": {
    "id": "mg_001",
    "name": "Core Modules",
    "code": "CORE",
    "description": "Mandatory core modules for all students.",
    "color": "#0361fc",
    "icon": "layers",
    "institutionId": "inst_123",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-06-01T00:00:00.000Z"
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}