Update a text

patch

https://api.lingohub.com/v2/texts/{textId}

Replaces the current variants using JSON merge-patch. An active key_id selects project automation and placeholder settings; changes affect every key of the segment. Omitted variants are unchanged, null is invalid and an empty array clears all variants. Empty or unchanged requests perform no writes. Array order supplies positions, including repeated device/plural combinations. Supports optional If-Match from getText; no upsert or arbitrary workflow-state mutation. Requires stack-level text management and segment, key and resource view permissions for the selected context.

Recipes

✏️

Update a translation safely (API V2)

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

textId

string

required

^txt_[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}$

Public identifier of the text.

Body Params

Request body to update the variants of a shared text. Omission leaves the variants unchanged; null is invalid; an empty array clears them. Changes affect every key of the segment.

variants

array of objects

length ≤ 1000

Replaces all current variants in array order. At most 1,000 entries and 1,048,576 UTF-16 code units in total.

variants

key_id

string

^ress_[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}$

Active key selecting the project settings and automations. Required with variants; changes still affect every key of the segment.

is_minor_update

boolean | null

Uses existing minor-edit status automation behavior. Omission or null means false. Only valid with variants.

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

200Current text returned.

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.

404The resource does not exist, or the API key cannot see it.

409conflict: project automation dependencies are unavailable, or a concurrent text/source-language operation prevents a stable conditional edit. Refresh and retry.

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

422The request is well-formed, but values are invalid; errors points at each of them.

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.