Manual
CLI
API
Log in Get started free

Request changes

Sends a translation back to its translator with a comment.

Sends a translation back to its translator with a comment.

HTTP
POST /keys/{keyId}/translations/{language}/request-changes

Access: Session token only. API keys get 403 with insufficient_scope.

Role: Project reviewer or manager.

Path parameters #

ParameterDescription
keyIdThe id of the key.
languageThe language code, such as de-de.

Request body #

JSON.

FieldTypeRequiredDescription
commentstringyesWhat to change. At most 2000 characters.
JSON
{ "comment": "Please use the formal form." }

Response 200 #

The translation with the status changes.

JSON
{ "value": "Kasse", "status": "changes" }

Response fields #

FieldTypeDescription
valuestringThe translation.
statusstringdraft, review or approved after saving, changes after requesting changes.

Errors #

StatuserrorWhen
401unauthenticatedThe token is missing or not valid.
404not_foundThe key does not exist, you have no access to its project, or keyId is not a UUID.
409branch_frozenThe branch is frozen. The same call also fails with project_frozen when the project is frozen.
403forbiddenYou are a translator in the project.
409not_in_reviewThe translation is not waiting for review.
422invalid_requestcomment is empty or too long.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.