Update a segment

patch

https://api.lingohub.com/v2/segments/{segmentId}

Updates shared metadata using JSON merge-patch. Changes affect every key of the segment. Omitted fields remain unchanged; null clears description or AI context, and an empty label_ids array clears labels. Plural changes must be supported by every active file format; becoming singular retains current OTHER-form texts and removes all other current plural forms across all languages. Supports optional If-Match. Requires stack-level segment management permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

segmentId

string

required

^seg_[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 shared segment.

Body Params

Request body to partially update shared segment metadata. Omitted fields remain unchanged; nullable strings may be cleared. Changes affect every key of the segment.

description

string | null

Shared translator-facing description; null clears it.

ai_context

string | null

Context for AI translation; null clears it.

is_not_translatable

boolean

Whether this shared segment is excluded from translation. Attribution and reason are derived by the server.

is_plural

boolean

Whether the segment uses plural forms. Every active file format must support the change. Becoming singular retains current OTHER-form texts and removes all other current plural forms across all languages.

label_ids

array of strings, unique

length ≤ 150

Replaces shared label assignments with existing labels in this workspace. Empty clears all labels. At most 150 distinct labels.

label_ids

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

200Updated shared segment.

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.

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.