Create a pathway in a curricula version

Creates a pathway (focus track) within a curricula version. Returns the created pathway row. Scoped to your integration’s institution via Basic Auth credentials.

POST/curricula/{id}/versions/{versionId}/pathways

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

versionIdstringrequired

Header parameters

Idempotency-Keystringrequired

Request body

requiredapplication/json

namestringrequired

typestringrequired

Allowed:FIXEDSELECTABLE_FOCUS

positioninteger

descriptionstring

Responses

201

Pathway created

dataCurriculaVersionPathwayrequired

Study pathway within a curricula version. FIXED pathways are mandatory; SELECTABLE_FOCUS pathways let students choose a focus area.

Show properties

idstringrequired

positionintegerrequired

namestringrequired

typestringrequired

FIXED = mandatory pathway; SELECTABLE_FOCUS = student chooses one focus.

Allowed:FIXEDSELECTABLE_FOCUS

curriculaVersionIdstringrequired

descriptionstring | null

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

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

Bodyapplication/json

namestring*typestring*positionintegerdescriptionstring

Request

curl -X POST 'https://fuxam.app/api/v4/curricula/string/versions/string/pathways' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "type": "FIXED",
  "position": 0,
  "description": "string"
}'

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

import requests

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

Response

{
  "data": {
    "id": "path_001",
    "position": 0,
    "name": "Software Engineering",
    "type": "SELECTABLE_FOCUS",
    "curriculaVersionId": "cv_001",
    "description": "Focus on software development."
  },
  "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"
    }
  ]
}