Create a curricula version

Creates a new version for an existing curriculum. Pass versionName in the body. Returns the version with nested parent curriculum. Use GET /curricula/{id}/versions/{versionId} for full structure. Scoped to your integration’s institution via Basic Auth credentials.

POST/curricula/{id}/versions

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

Header parameters

Idempotency-Keystringrequired

Request body

requiredapplication/json

versionNamestringrequired

Responses

201

Version created

dataCurriculaVersionCreateResultrequired

Curriculum version returned by POST /curricula/{id}/versions, including nested parent curriculum.

Show properties

curriculaobjectrequired

Parent curriculum, including any connected study programs.

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

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*Idempotency-Keyheader*

Bodyapplication/json

versionNamestring*

Request

curl -X POST 'https://fuxam.app/api/v4/curricula/string/versions' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "versionName": "string"
}'

const response = await fetch("https://fuxam.app/api/v4/curricula/string/versions", {
  method: "POST",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Idempotency-Key": "string",
    "Content-Type": "application/json"
  },
  body: "{\n  \"versionName\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://fuxam.app/api/v4/curricula/string/versions",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Idempotency-Key": "string",
        "Content-Type": "application/json"
    },
    data="{\n  \"versionName\": \"string\"\n}",
)

Response

{
  "data": {
    "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,
    "isDefault": true,
    "curricula": {
      "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",
      "studyProgramConnectedCurricula": []
    }
  },
  "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"
    }
  ]
}