Saltar al contenido
Docs
Español
Esc
navigateopen⌘Jpreview

Update a curriculum

Partial update of curriculum fields (name, code). Optionally pass moduleIds to attach modules to the first version. Returns updated fields with the first version included. Use GET /curricula/{id} for full structure. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/curricula/{id}
Path parameters
idstringrequired
Request body
requiredapplication/json
namestring
codestring
moduleIdsstring[]
Optional module IDs to attach to the first version.
Responses
200Updated curriculum
dataCurriculaUpdateResultrequired
Curriculum returned by PATCH /curricula/{id}: updated fields with the first version included.
Show properties
versionsCurriculaVersion[]
Show properties
Array of CurriculaVersion
idstringrequired
versionstringrequired
namestringrequired
curriculaIdstringrequired
isDefaultbooleanrequired
isCohortVersionbooleanrequired
sourceCohortIdstring | null
electionModestring | null
When students may elect modules. Null when election is not configured.
Allowed:ELECT_WHENEVERELECT_BEFORE_TERMELECT_AFTER_TERM
electionStartWeeksinteger | null
Weeks before term when election opens.
electionEndWeeksinteger | null
Weeks before term when election closes.
createdAtstring<date-time>required
updatedAtstring<date-time>required
idstringrequired
namestringrequired
institutionIdstringrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
isCohortSpecificbooleanrequired
isArchivedboolean | null
codestring | null
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/curricula/string" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "code": "string",
  "moduleIds": [
    "string"
  ]
}'
Response
{
  "data": {
    "id": "cur_001",
    "name": "Bachelor CS 2024",
    "institutionId": "inst_123",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-06-01T00:00:00.000Z",
    "isCohortSpecific": false,
    "isArchived": false,
    "code": "CS-2024",
    "versions": [
      {
        "id": "cv_001",
        "version": "1.0",
        "name": "Default",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-06-01T00:00:00.000Z",
        "curriculaId": "cur_001",
        "electionEndWeeks": null,
        "electionMode": null,
        "electionStartWeeks": null,
        "isCohortVersion": false,
        "sourceCohortId": null
      }
    ]
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}