Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Create a study program

Creates a study program with an initial version. Returns the full program (same shape as GET /study-programs/{id}). Optionally pass curriculaIds to connect curricula. Use hasCohorts and hasStatistics to control cohort-based enrollment and university statistics (both default to true when omitted). Scoped to your integration’s institution via Basic Auth credentials.

POST/study-programs
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Header parameters
Idempotency-Keystringrequired
Request body
requiredapplication/json
namestringrequired
codestring
initialVersionNamestring
objectivestring
defaultStudyTimeinteger
hasCohortsboolean

Whether the program uses cohorts for enrollment. Defaults to true when omitted.

hasStatisticsboolean

Whether university statistics are collected for this program. Defaults to true when omitted.

curriculaIdsstring[]

Optional curriculum IDs to connect.

Responses
201

Study program created

dataStudyProgramrequired

Study program list, detail, create, and update response. Includes program versions, responsible users, connected curricula, and summary counts. Use GET /cohorts?studyProgramId={id} for cohort details.

Show properties
idstringrequired
namestringrequired
institutionIdstringrequired
objectivestring | null
isArchivedbooleanrequired
codestring | null
statisticDataobject | null
defaultStudyTimeinteger
defaultTuitionFeePlanIdstring | null
hasCohortsbooleanrequired
hasStatisticsbooleanrequired
typestring | null
studyProgramVersionStudyProgramVersion[]required

Program versions (cohorts are listed separately).

Show properties
Array of StudyProgramVersion
idstringrequired
namestringrequired
institutionIdstringrequired
studyProgramIdstringrequired
isDefaultbooleanrequired
statisticDataobject | null
responsibleUsersSimpleUser[]required

studyProgramResponsibleUser[].user, sorted by name. The

Show properties
Array of SimpleUser
idstringrequired
namestringrequired
emailstring<email>required
imagestring | nullrequired
connectedCurriculaStudyProgramConnectedCurricula[]required

Flattened curricula from studyProgramConnectedCurricula (see StudyProgramConnectedCurricula). The

Show properties
Array of StudyProgramConnectedCurricula
idstringrequired
namestringrequired
institutionIdstringrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
isCohortSpecificbooleanrequired
isArchivedbooleanrequired
codestring | null
versionsCountintegerrequired
firstVersionStudyProgramVersionrequired

The first program version.

Show properties
idstringrequired
namestringrequired
institutionIdstringrequired
studyProgramIdstringrequired
isDefaultbooleanrequired
statisticDataobject | null
defaultVersionStudyProgramVersion | null

The default program version, if one is set.

Show properties
One of:
StudyProgramVersion
idstringrequired
namestringrequired
institutionIdstringrequired
studyProgramIdstringrequired
isDefaultbooleanrequired
statisticDataobject | null
null
null
versionsCountintegerrequired

Total number of program versions.

cohortsCountintegerrequired

Total cohort count across all versions.

studyProgramMetadataobject | nullrequired

Always null on list and detail responses; use version-specific endpoints for metadata.

metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
watermarkstring<date-time>

Present on GET /users?updatedSince= pages. Taken at the first page minus a 60s overlap. Bound into pagination.next_cursor. Use it as the next updatedSince after deduping by user id. Delivery is inclusive >= and at-least-once.

400

Bad Request

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
401

Unauthorized

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
409

Conflict — duplicate email or membership code (body includes existingUserId when known), a time-tracking session that is already running (activeSession), a time-tracking interval that overlaps an existing log (conflictingLog), idempotency key reused with a different body (idempotency_key_reused), or concurrent request with the same key still in progress (idempotency_key_in_progress)

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
429

Too Many Requests — 1000 requests per minute per institution. Includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (ISO-8601), and Retry-After (seconds).

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
500

Internal Server Error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://fuxam.app/api/v4/study-programs' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Bachelor Computer Science",
  "code": "BSC-CS",
  "initialVersionName": "1.0",
  "objective": "Train software engineers with strong fundamentals.",
  "defaultStudyTime": 6,
  "hasCohorts": true,
  "hasStatistics": true,
  "curriculaIds": [
    "cur_abc123"
  ]
}'
Response
{
  "data": {
    "id": "sp_abc123",
    "name": "Bachelor of Science",
    "institutionId": "inst_123",
    "objective": "Graduate competent professionals.",
    "isArchived": false,
    "code": "BSC-001",
    "statisticData": null,
    "defaultStudyTime": 6,
    "defaultTuitionFeePlanId": null,
    "hasCohorts": true,
    "hasStatistics": false,
    "type": "BACHELOR",
    "studyProgramVersion": [
      {
        "id": "spv_001",
        "name": "2024 Intake",
        "institutionId": "inst_123",
        "studyProgramId": "sp_abc123",
        "isDefault": true,
        "statisticData": null
      }
    ],
    "responsibleUsers": [
      {
        "id": "user_abc123",
        "name": "Jane Doe",
        "email": "jane@example.com",
        "image": null
      }
    ],
    "connectedCurricula": [
      {
        "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",
        "versionsCount": 2
      }
    ],
    "firstVersion": {
      "id": "spv_001",
      "name": "2024 Intake",
      "institutionId": "inst_123",
      "studyProgramId": "sp_abc123",
      "isDefault": true,
      "statisticData": null
    },
    "defaultVersion": {
      "id": "spv_001",
      "name": "2024 Intake",
      "institutionId": "inst_123",
      "studyProgramId": "sp_abc123",
      "isDefault": true,
      "statisticData": null
    },
    "versionsCount": 1,
    "cohortsCount": 1,
    "studyProgramMetadata": null
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}

War diese Seite hilfreich?