academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Teaching-languages [Beta] → Update teaching language

AI-generated

Summary

Sends a partial update (PATCH) to a specific teaching language resource in the academyFIVE API.

Inputs

  • data (required) — A fixed collection object containing the data to update. Must include an 'id' field identifying the resource and a nested 'attributes' object.
  • data.type (required) — The type of the resource (e.g., 'teaching-language'). Must match the resource type exactly.
  • data.id (required) — The unique identifier of the teaching language to update.
  • data.attributes (required) — A fixed collection of fields to update on the resource. Supports labelDe, labelEn, position, and languageKey.
  • data.attributes.labelDe — German label for the teaching language.
  • data.attributes.labelEn — English label for the teaching language.
  • data.attributes.position — Numeric position for ordering.
  • data.attributes.languageKey — A unique key for the language. If provided, it must be unique.

Output shape

A single JSON item containing the API response data (status code, headers, and body).

Returns a single item per input item. The response body contains the updated resource details.

Examples

Example 1: Update the position and label of a teaching language identified by ID 123.

data.type: 'teaching-language', data.id: '123', data.attributes: { position: 5, labelEn: 'Updated Label' }

Example 2: Change the German label for a specific teaching language.

data.type: 'teaching-language', data.id: '456', data.attributes: { labelDe: 'Neuer Deutsch-Text' }

Links

Discussion