Tolgee Octri Demo
PUT/v2/projects/{projectId}/translations/{translationId}/set-state/{state}

Set a translation state

Updates the state of a translation in a project. Set state to TRANSLATED or REVIEWED to record its progress. The response includes the translation record and its current state.

3 parameters
translationIdintegerrequired
The integer identifier of the translation to update.
statestringrequired
The translation state to set: `TRANSLATED` or `REVIEWED`.
Allowed:TRANSLATEDREVIEWED
projectIdintegerrequired
The integer identifier of the project containing the translation.

5 status codes
200Returns the translation record, including its identifier, text, state, whether it was translated automatically, and whether it is outdated.
autobooleanrequired
Was translated using Translation Memory or Machine translation service?
idintegerrequired
Id of translation record
mtProviderstringoptional
Which machine translation service was used to auto translate this
Allowed:GOOGLEAWSDEEPLAZUREBAIDUPROMPT
outdatedbooleanrequired
Whether base language translation was changed after this translation was updated
statestringrequired
State of translation
Allowed:UNTRANSLATEDTRANSLATEDREVIEWEDDISABLED
textstringoptional
Translation text
400Returned when the request is invalid.
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 not authorized.
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 the authenticated user does not have permission to update the translation state.
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 is not 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 is invalid; a 401 when the authenticated user is not authorized; a 403 when the authenticated user lacks permission; and a 404 when the translation or project is not found. The translationId and projectId path parameters must identify the translation and project, and the state path parameter must be TRANSLATED or REVIEWED.