LOlokalise
Keys

Update a key

Updates the properties of a key and it's associated objects. Requires Manage keys admin right.

Ad hoc documents projects (paged_documents) only allow updating <code>tags</code> (with <code>merge_tags</code>), <code>description</code>, <code>is_hidden</code>, <code>char_limit</code> and <code>custom_attributes</code>; any other property returns a <code>400</code> validation error.

Requires <code>write_keys</code> OAuth access scope.

put/projects/{project_id}/keys/{key_id}

Request

  • Base URL
    https://api.lokalise.com/api2
  • URL
    https://api.lokalise.com/api2/projects/{project_id}/keys/{key_id}
  • Auth
    API key in header X-Api-Token

Path parameters

project_idstring required

A unique project identifier

key_idnumber required

A unique identifier of the key.

Request body

key_namestring

Key identifier. For projects with enabled Per-platform key names, pass JSON encoded string with included <code>ios</code>, <code>android</code>, <code>web</code> and <code>other</code> string attributes.

descriptionstring

Description of the key.

platformsstring[]

List of platforms, enabled for this key. Possible values are <code>ios</code>, <code>android</code>, <code>web</code> and <code>other</code>.

tagsstring[]

List of tags for this keys.

merge_tagsboolean

Enable to merge specified tags with the current tags attached to the key.

is_pluralboolean

Whether this key is plural.

plural_namestring

Optional custom plural name (used in some formats).

is_hiddenboolean

Whether this key is hidden from non-admins (translators).

is_archivedboolean

Whether this key is archived.

contextstring

Optional context of the key (used with some file formats).

char_limitnumber

Maximum allowed number of characters in translations for this key.

custom_attributesstring

JSON encoded string containing <a href="https://docs.lokalise.com/developer-docs/custom-key-attributes">custom attributes</a> (if any).

Response

OK

project_idstring

Changes

No recorded changes to this operation across all 2 revisions of this API.