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

Update a translation comment

Replaces the state and text of a comment on a translation in a project. Provide both state and non-empty text in the request body. The response contains the updated comment record.

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

The replacement 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
200Returns the updated translation 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 update the comment.
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 comment, 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 comment, translation, or project cannot be found. The commentId path parameter, translationId path parameter, and projectId path parameter must identify the comment and its containing resources. Both state and text are required; state must be RESOLUTION_NOT_NEEDED, NEEDS_RESOLUTION, or RESOLVED, and text must contain at least one character.