Update a term form

patch

https://api.lingohub.com/v2/term-forms/{termFormId}

Partially updates the term form identified by the given ID (JSON merge-patch). Omitted fields are left unchanged, null clears a nullable field. inherited_by replaces the languages inheriting the form; a language removed from it keeps a copy of the form. Returns the full updated form. Requires workspace-level glossary management permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

termFormId

string

required

^ter_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Unique identifier of the term form.

Body Params

Request body to partially update a term form (JSON merge-patch). Omitted fields are left unchanged, null clears a nullable field. The language of a form cannot change: add a form in the other language and delete this one instead.

text

string

length ≤ 4096

The form's text.

usage_status

string

enum

How a term form should be used:

PREFERRED: the recommended form. A language of a term has at most one preferred form.
ADMITTED: an accepted alternative form.
NOT_RECOMMENDED: a discouraged or deprecated form.

Allowed:

inherited_by

array of strings

length ≤ 100

Languages without a form of their own that use this form. Replaces the current list; only for the preferred form of a translatable term. A language removed from the list keeps a copy of the form.

inherited_by

form_type

enum

Lexical type of a term form.

part_of_speech

enum

Part of speech of the term form.

grammatical_number

enum

Grammatical number of the term form.

grammatical_gender

enum

Grammatical gender of the term form.

matching

string

enum

Strategy used to match the term against translatable text.

Allowed:

match_expression

string | null

The regular expression a CUSTOM matching uses. Null clears it.

case_sensitivity

string

enum

How a term form is matched with regard to case:

SENSITIVE: only text of the same case matches.
PERMISSIVE: text of any case matches, and a case difference is flagged as a hint.
INSENSITIVE: text of any case matches.

Allowed:

Headers

If-Match

string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Term form updated successfully.

400The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.

401Invalid or missing API key.

403Insufficient permissions.

404Term form not found.

409The language already has a preferred form (already_exists on usage_status).

412The current representation does not match If-Match (precondition_failed). No change was applied.

422Validation error.

429The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

500An unexpected internal server error occurred.

503The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.