Tolgee Octri Demo
POST/v2/projects/{projectId}/translations/{translationId}/comments

Create a translation comment

Creates a comment on a specific translation in a project. Provide a comment state and non-empty text to record the comment and its resolution status. The response contains the created comment, including its author and timestamps.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 2 body fields
translationIdintegerrequired
The unique identifier of the translation to comment on.
projectIdintegerrequired
The unique identifier of the project containing the translation.

The comment state and text. Both fields are required.

statestringrequired
The comment state: RESOLUTION_NOT_NEEDED, NEEDS_RESOLUTION, or RESOLVED.
Allowed:RESOLUTION_NOT_NEEDEDNEEDS_RESOLUTIONRESOLVED
textstringrequired
The comment text. Must contain at least one character.

5 status codes
201Returns the created comment, including its author, identifier, state, text, and creation and update timestamps.
authorobjectrequired
User who created the comment
createdAtstringrequired
Date when it was created
idintegerrequired
Id of translation comment record
statestringrequired
State of translation
Allowed:RESOLUTION_NOT_NEEDEDNEEDS_RESOLUTIONRESOLVED
textstringrequired
Text of comment
updatedAtstringrequired
Date when it was updated
400Returned when a required field is missing or a field value fails validation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when you do not have permission to comment on the translation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the translation or project cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request body is invalid. A 401 is returned when authentication is missing or invalid, a 403 when you lack permission, and a 404 when the translation or project cannot be found. The translationId path parameter and projectId path parameter must identify the translation and its project. Both state and text are required; state must be RESOLUTION_NOT_NEEDED, NEEDS_RESOLUTION, or RESOLVED, and text must contain at least one character.