Create a module group

Creates a module group. Returns the created group (same shape as GET /module-groups/{id}). Optionally pass moduleIds to attach modules (each module’s default version is used). Scoped to your integration’s institution via Basic Auth credentials.

POST/module-groups

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

colorstring

iconstring

moduleIdsstring[]

Optional module IDs to attach (resolved to default versions).

Responses

201

Module group created

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

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

Request body

Request

curl -X POST 'https://fuxam.app/api/v4/module-groups' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "code": "string",
  "description": "string",
  "color": "string",
  "icon": "string",
  "moduleIds": [
    "string"
  ]
}'

const response = await fetch("https://fuxam.app/api/v4/module-groups", {
  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  \"color\": \"string\",\n  \"icon\": \"string\",\n  \"moduleIds\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://fuxam.app/api/v4/module-groups",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Idempotency-Key": "string",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"code\": \"string\",\n  \"description\": \"string\",\n  \"color\": \"string\",\n  \"icon\": \"string\",\n  \"moduleIds\": [\n    \"string\"\n  ]\n}",
)

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_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"
    }
  ]
}