TIP: If you wish to add source keys, use the Import endpoint.

Delete source key #️⃣

[DELETE] /projects/{projectId}/keys/{keyId}
Description Value
Accessible with project token true
Accessible with organization token true
Need write permission true
Available from role manager
API level normal

Remove source key from a project.

Params

  • {projectId} - Your project id or slug. Use the value from projects endpoint.
  • {keyId} - ID of the key you’d like to remove.

Sample Request #️⃣

curl --request DELETE \
  --url https://api.localazy.com/projects/{projectId}/keys/{keyId} \
  --header 'Authorization: Bearer {{token}}'

Sample Response #️⃣

{
  "result": true
}

Update source key #️⃣

[PUT] /projects/{projectId}/keys/{keyId}
Description Value
Accessible with project token true
Accessible with organization token true
Need write permission true
Available from role manager
API level normal

Update source key properties (one of hidden, deprecated, character limit and comment for translators) for a key.

Params

  • {projectId} - Your project id or slug. Use the value from projects endpoint.
  • {keyId} - ID of the key you’d like to modify.

Sample Request #️⃣

curl --request PUT \
  --url https://api.localazy.com/projects/{projectId}/keys/{keyId} \
  --header 'Authorization: Bearer {{token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "deprecated": 37,
  "hidden": true,
  "comment": "Custom comment for the translator",
  "limit": 100
}'

Request Object

Field Description
deprecated Set to 0 or greater to mark the key as deprecated in the corresponding version; set to -1 to mark the key as not deprecated.
hidden Set to true to mark the key as hidden for translation in Localazy.
comment Provide custom comment for translators.
limit Change the limit of translation length or set to -1 to disable it.

All fields are optional and if omitted, the corresponding property is left unchanged.

Sample Response #️⃣

{
  "result": true
}

Set tags on a key #️⃣

[PUT] /projects/{projectId}/keys/{keyId}/tags
Description Value
Accessible with project token true
Accessible with organization token true
Need write permission true
Available from role manager
API level normal

Add and/or remove named tags on a single key. Tags are matched by name; any name passed in addTags that does not yet exist in the project is created automatically. Names passed in removeTags that do not exist are silently ignored.

Params

  • {projectId} - Your project id or slug. Use the value from projects endpoint.
  • {keyId} - ID of the key whose tags you’d like to modify.

Sample Request #️⃣

curl --request PUT \
  --url https://api.localazy.com/projects/{projectId}/keys/{keyId}/tags \
  --header 'Authorization: Bearer {{token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "addTags": ["marketing", "v2"],
  "removeTags": ["legacy"]
}'

Request Object

Field Description
addTags Optional list of tag names to attach to the key. Missing tags are created.
removeTags Optional list of tag names to detach from the key. Unknown names are ignored.

If both fields are omitted or empty, the request is a no-op and result: true is returned.

Sample Response #️⃣

{
  "result": true
}

Set tags on multiple keys #️⃣

[PUT] /projects/{projectId}/keys/tags
Description Value
Accessible with project token true
Accessible with organization token true
Need write permission true
Available from role manager
API level normal

Add and/or remove named tags on a batch of keys in a single request. Up to 1000 keys per call.

Params

Sample Request #️⃣

curl --request PUT \
  --url https://api.localazy.com/projects/{projectId}/keys/tags \
  --header 'Authorization: Bearer {{token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "keys": ["_a8503372675164909925", "_a8503372675164909931"],
  "addTags": ["marketing"],
  "removeTags": ["legacy"]
}'

Request Object

Field Description
keys Required. Array of key IDs to update. Maximum 1000 entries per request.
addTags Optional list of tag names to attach to every listed key. Missing tags are created.
removeTags Optional list of tag names to detach from every listed key. Unknown names are ignored.

Sample Response #️⃣

{
  "result": true
}

Set priority on a key #️⃣

[PUT] /projects/{projectId}/keys/{keyId}/priority
Description Value
Accessible with project token true
Accessible with organization token true
Need write permission true
Available from role manager
API level normal

Set the priority of a single key. Priority is implemented internally as a system tag, so setting a new priority replaces any priority previously assigned to the key.

Params

  • {projectId} - Your project id or slug. Use the value from projects endpoint.
  • {keyId} - ID of the key whose priority you’d like to modify.

Sample Request #️⃣

curl --request PUT \
  --url https://api.localazy.com/projects/{projectId}/keys/{keyId}/priority \
  --header 'Authorization: Bearer {{token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "priority": "high"
}'

Request Object

Field Description
priority Required. One of lowest, low, normal, high, highest. Use normal to clear any existing priority on the key.

Sample Response #️⃣

{
  "result": true
}

Set priority on multiple keys #️⃣

[PUT] /projects/{projectId}/keys/priority
Description Value
Accessible with project token true
Accessible with organization token true
Need write permission true
Available from role manager
API level normal

Set the same priority on a batch of keys in a single request. Up to 1000 keys per call.

Params

Sample Request #️⃣

curl --request PUT \
  --url https://api.localazy.com/projects/{projectId}/keys/priority \
  --header 'Authorization: Bearer {{token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "keys": ["_a8503372675164909925", "_a8503372675164909931"],
  "priority": "high"
}'

Request Object

Field Description
keys Required. Array of key IDs to update. Maximum 1000 entries per request.
priority Required. One of lowest, low, normal, high, highest. Use normal to clear any existing priority on the listed keys.

Sample Response #️⃣

{
  "result": true
}