Tolgee Octri Demo
POST/v2/projects/{projectId}/translations/{translationId}/qa-issues/suppressions

Create a QA issue suppression

Creates a QA issue suppression for a translation using the supplied issue details. Provide the required message and type in the request body, with optional match fields to define the issue. Use the project and translation identifiers to scope the suppression.

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

2 parameters · 7 body fields
projectIdintegerrequired
The int64 identifier of the project containing the translation.
translationIdintegerrequired
The int64 identifier of the translation for which you want to create a QA issue suppression.

Match details for the QA issue to suppress. message and type are required.

messagestringrequired
The QA issue message identifier. Must be one of the accepted message values.
Allowed:qa_empty_translationqa_missing_plural_categoryqa_check_failedqa_spaces_leading_addedqa_spaces_leading_removedqa_spaces_trailing_addedqa_spaces_trailing_removedqa_spaces_doubledqa_spaces_non_breaking_addedqa_spaces_non_breaking_removedqa_punctuation_addqa_punctuation_remove
paramsobjectoptional
String key-value parameters used to match the QA issue.
pluralVariantstringoptional
The plural variant used to match the QA issue.
positionEndintegeroptional
The int32 ending position used to match the issue location.
positionStartintegeroptional
The int32 starting position used to match the issue location.
replacementstringoptional
The replacement text used to match the QA issue.
typestringrequired
The QA issue type. Must be one of the accepted type values.
Allowed:EMPTY_TRANSLATIONMISSING_PLURAL_CATEGORIESCHARACTER_CASE_MISMATCHREPEATED_WORDSPUNCTUATION_MISMATCHTRIM_CHECKSPACES_MISMATCHUNMATCHED_NEWLINESMISSING_NUMBERSSPECIAL_CHARACTER_MISMATCHBRACKETS_MISMATCHBRACKETS_UNBALANCED

5 status codes
200Returns confirmation that the QA issue suppression was created.
400Returned when the request body is invalid, omits a required field, or supplies an unsupported enum value.
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 does not have valid authentication.
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 create the suppression.
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 specified project or translation 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 or omits message or type. A 401 is returned when the request has no valid authentication, and a 403 is returned when the authenticated user lacks permission to create the suppression. A 404 is returned when the specified project or translation cannot be found. message and type must use values accepted by their respective enums.