Update an organization term

Partial update of term name, code, date range, and optional election or reassessment registration windows. When updating dates, the effective range (merged with existing values for omitted fields) must have termStart strictly before termEnd. Returns 422 when start and end are the same instant (… must not be the same) or when start is after end (… must be before …). Scoped to your integration’s institution via Basic Auth credentials.

PATCH/organization-terms/{id}

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

Request body

requiredapplication/json

namestring

codestring

termStartstring<date-time>

Term start date. Must include a timezone offset (Z or ±HH:MM); values without offset return 422. Must be strictly before termEnd. If equal to termEnd, the API returns 422 with field error termStart and termEnd must not be the same.

termEndstring<date-time>

Term end date. Must include a timezone offset (Z or ±HH:MM); values without offset return 422. Must be strictly after termStart. If equal to termStart, the API returns 422 with field error termStart and termEnd must not be the same.

electionStartstring<date-time>

electionEndstring<date-time>

reassessmentRegistrationStartstring<date-time>

reassessmentRegistrationEndstring<date-time>

Responses

200

Updated term

dataOrganizationTermrequired

Academic term (semester) with optional module election and reassessment registration windows.

Show properties

idstringrequired

namestringrequired

termEndstring<date-time>required

End of the academic term.

institutionIdstringrequired

termStartstring<date-time>required

Start of the academic term.

codestring | null

electionEndstring<date-time> | null

Deadline for module elections for this term.

electionStartstring<date-time> | null

When students may begin electing modules for this term.

reassessmentRegistrationEndstring<date-time> | null

When reassessment registration closes.

reassessmentRegistrationStartstring<date-time> | null

When reassessment registration opens.

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

422

Unprocessable Entity — validation or business rule 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

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*

Bodyapplication/json

namestringcodestringtermStartstringTerm start date. Must include a timezone offset (`Z` or `±HH:MM`); values without offset return 422. Must be strictly before `termEnd`. If equal to `termEnd`, the API returns `422` with field error `termStart and termEnd must not be the same`.termEndstringTerm end date. Must include a timezone offset (`Z` or `±HH:MM`); values without offset return 422. Must be strictly after `termStart`. If equal to `termStart`, the API returns `422` with field error `termStart and termEnd must not be the same`.electionStartstringelectionEndstringreassessmentRegistrationStartstringreassessmentRegistrationEndstring

Request

curl -X PATCH 'https://fuxam.app/api/v4/organization-terms/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "WS 2026/27",
  "code": "WS26",
  "termStart": "2026-10-01T00:00:00.000Z",
  "termEnd": "2027-03-31T23:59:59.000Z",
  "electionStart": "2026-09-01T00:00:00.000Z",
  "electionEnd": "2026-09-15T23:59:59.000Z"
}'

const response = await fetch("https://fuxam.app/api/v4/organization-terms/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"WS 2026/27\",\n  \"code\": \"WS26\",\n  \"termStart\": \"2026-10-01T00:00:00.000Z\",\n  \"termEnd\": \"2027-03-31T23:59:59.000Z\",\n  \"electionStart\": \"2026-09-01T00:00:00.000Z\",\n  \"electionEnd\": \"2026-09-15T23:59:59.000Z\"\n}"
});

import requests

response = requests.patch(
    "https://fuxam.app/api/v4/organization-terms/string",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"WS 2026/27\",\n  \"code\": \"WS26\",\n  \"termStart\": \"2026-10-01T00:00:00.000Z\",\n  \"termEnd\": \"2027-03-31T23:59:59.000Z\",\n  \"electionStart\": \"2026-09-01T00:00:00.000Z\",\n  \"electionEnd\": \"2026-09-15T23:59:59.000Z\"\n}",
)

Response

{
  "data": {
    "id": "ot_001",
    "name": "WS 2024/25",
    "termEnd": "2025-03-31T23:59:59.000Z",
    "institutionId": "inst_123",
    "termStart": "2024-10-01T00:00:00.000Z",
    "code": "WS24",
    "electionEnd": null,
    "electionStart": null,
    "reassessmentRegistrationEnd": null,
    "reassessmentRegistrationStart": 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"
    }
  ]
}

{
  "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"
    }
  ]
}