Update a key

patch

https://api.lingohub.com/v2/keys/{keyId}

Updates only the display name of a key with JSON merge-patch. Omitted fields stay unchanged and an empty object writes nothing. This is supported for CSV and externally keyed formats; the key itself is changed with renameKey. Source imports may overwrite the name under existing import settings. Supports optional If-Match against getKey. Requires segment and key management plus resource view permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

keyId

string

required

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

Public identifier of the key.

Body Params

Request body to update the display name of a key. Source imports may overwrite the name under existing import settings. The key and its position are unchanged.

name

string

length ≤ 50000

Display name of the key. Omission preserves it; null is not accepted.

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 key.

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.