Manual
CLI
API
Log in Get started free

Add a note to a key

Adds a note for translators to a key.

Adds a note for translators to a key.

HTTP
POST /keys/{keyId}/notes

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

Role: Project reviewer or manager.

Path parameters #

ParameterDescription
keyIdThe id of the key.

Request body #

JSON.

FieldTypeRequiredDescription
bodystringyesThe note. At most 2000 characters.
JSON
{ "body": "Button label, keep it short." }

Response 201 #

The note is added. There is no body.

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.
403forbiddenYou are a translator in the project.
422invalid_requestbody is empty or too long.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.