Update a continuing education program version

Renames a continuing education program version. The version to update is identified by the versionId path parameter; the request body accepts optional name (the new display label). To create a version, use POST and pass versionName in the body instead. Returns the updated version with nested cohorts — same shape as GET /continuing-education/{id}/versions/{versionId}. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/continuing-education/{id}/versions/{versionId}

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

versionIdstringrequired

Request body

requiredapplication/json

namestring

Responses

200

Updated version

dataStudyProgramVersionDetailrequired

Study program version with nested cohorts. Returned by GET /study-programs/{id}/versions/{versionId}.

Show properties

cohortsCohort[]

Show properties

Array of Cohort

idstringrequired

namestringrequired

institutionIdstringrequired

startDatestring<date-time>required

endDatestring<date-time>required

curriculaVersionIdstringrequired

studyProgramVersionIdstringrequired

isArchivedbooleanrequired

hasDisconnectedFromCurriculaboolean

originalCurriculaVersionIdstring | null

idstringrequired

namestringrequired

institutionIdstringrequired

studyProgramIdstringrequired

isDefaultbooleanrequired

statisticDataobject | null

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

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

Bodyapplication/json

namestring

Request

curl -X PATCH 'https://fuxam.app/api/v4/continuing-education/string/versions/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "2025 Edition"
}'

const response = await fetch("https://fuxam.app/api/v4/continuing-education/string/versions/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"2025 Edition\"\n}"
});

import requests

response = requests.patch(
    "https://fuxam.app/api/v4/continuing-education/string/versions/string",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"2025 Edition\"\n}",
)

Response

{
  "data": {
    "id": "spv_001",
    "name": "2024 Intake",
    "institutionId": "inst_123",
    "studyProgramId": "sp_abc123",
    "isDefault": true,
    "statisticData": null,
    "cohorts": [
      {
        "id": "coh_001",
        "name": "WS 2024/25",
        "institutionId": "inst_123",
        "startDate": "2024-10-01T00:00:00.000Z",
        "endDate": "2027-09-30T00:00:00.000Z",
        "curriculaVersionId": "cv_001",
        "studyProgramVersionId": "spv_001",
        "isArchived": false,
        "hasDisconnectedFromCurricula": false,
        "originalCurriculaVersionId": null
      }
    ]
  },
  "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"
    }
  ]
}