Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 42.5 KB

delete-keys.api.mdx

File metadata and controls

71 lines (54 loc) · 42.5 KB
id title description sidebar_label hide_title hide_table_of_contents api sidebar_class_name info_path custom_edit_url
delete-keys
Delete keys
Delete keys
Delete keys
true
true
eJztXN1z2za2/1e4fNndGSVO08590JviKF01jpNrK3e3k/FgIfJIQkwCLADKVj3+3++cA4AEKTpuu/uyO3hpZHwcHhycb/ymD7nlO5PPv+RvuC322ccGNLdCSZPfzHIV/lqV+TwvoQIL7+Fo8lnecM1rsKBx80MueQ35PG+0+gqFXZX5LBcSB7jd57Ncwy+t0FDmc6tbmOW8qtTdsm7s8f941UI+3/LKwCw3xR5qns8fcntskKCQFnag81m+Vbrm1g39zw/54+ONIwvGvlHlEfcUSlqQFn/ypqlEQbyffTVK4lhPvGfnS34Lx1VJp/WfVBs8Ah5R4/mtAIN7/LqeNa41P+I5LdTmt7H8OMutsBWuetsJ88odwk0PBUUDplHSOB5ev3qF/5RgCi0aPFw+zz++z2d/7OiFBm6hXOBhRelOvNNg8H6N5bbFH1ZZXq3ojF5Es7xtSr/xWbHxwoqDsMcrOAjjNWlCVMMjrfeQhY2Z9jszUc4yu+c2M1ZpMJmNV5VguahMprY0/lVtJi5glvPW7pUeC8JpdhnE0BrQpNDPn+7ALT8hV3G9QzHZfVtvJBfV84Tcll4yxmohd8hxT+R09nGWwz2vG9KoCyFvTWZV5pjKRM13QJfmVW7hmH2cdeftKW6UqoBLnBTTN3QqS2fzEyx38pvkOLBzLZDxzwb0oihUK+0HVUKF+3u9/G2qYkUN2d0eZLj6zFOYZBu0VvoDGMOnJD6mv+r0KdtyUQHpoDCZcPpHxLLaU3taekOiztciTTHNY2eIv0EAaJ8ZOSFvHnt+gGwDILNGqwKMgTIzKtvy8TV+/xq/5S39WUlc07pgYJtwhHyWg2xr1PtPy8u3q8sf81l+9fny0v26/nx+vry+zmf5u8XqYvk2n+Xni8vz5YX7/Xb55uPny/Pl2/zmceBrftfBJ8/ltj93qvWxgW+e6WrJ1leLy+uLxXrJ3qzZ+kM+yz8szv+2uoxm8lm++Lz+OBh4u7xYrpfs/fJnPP71ct3Nrj5eXrPrtVt2frFcXA2mcPDjp5/HY+vFj4HY58voD6SMP9nl4sPy+tPiPHDzgbbms/zN6uJidfkjW1+tFhds+Y9PqyuaYpcf16vzJcm+9+l/1OjuuMkqbmzmSWV/caqVFXsud/DXqYjYuwOyiZ/UxnsBioY/TMW7N7zMQsz8HYGvc5SYJ5T4xaNqWSlKZlQNdi/kjt1pRSpCyQ1lRd1cPsvdLMpKSfi4pbxnEE6R7LOe3n38VC2DwrUSYxRIi0chF8YbwXiBhsy2Sm9EWYL0w7dwZFJZtlWtdDnXgVeiZH4uGvGZWTQzGmFw39BJZvmGl6zQUCITvELrqrecgeSbCuKvKNswOo5bgIz0iwouaUTDQd0CU3eSNaBrYQxll7O85JazQmndNjaQFZauj6iyUoFxRO+FsUzpiMWKy13Ld8As37l5E49i9JkajkTV5bY0SqxZx4eGnTDWp8E0S+kqlJHQYkoajGp1MSRvCtUMR5yMPUt2L3TJGq7tkeF9MwokLASSiQVSMagxDZick6xG+0El/sYqZtrN1EwrbyVeEDGBuogkGK808PLIDqDFVtDx451OUZUWv55M7ZTaVcDulL41DS+A1cIQf6N15k7YYs+EFFZ4ZZ+YLpTcVoJMKWQWHW+dQLsZpVnDjblTumReUf10t2nPzUgXT6a1qiCMx5e4FZW7VcquwoBVim3ELjIN9I7G8rrppImbIknSx+WOFbyqNry4Za2uov1f7yyz6pYM3Wv9YGwHEjSvaCzcWsElsSpkyUwrLFoi42WJiQRJFNWyanfESivFL213ROH0vIZ6A5qpLVN6x6X4lWwAjSX6k+QjFVN2j2vvJAUIIuNnOs9CTiv6xoBM2OnZNmDZUbV6wlNMbne89u7VOcK6pWOjJOtGacuGtq9VHbgjwQpj8RIGiwxUUDhlDJoX5IOWXh2GDihoTbzNnajh2gBDBSFSbVXGRFjgu9/Ay5LVSgND/8++e/WqYwylIFX/J24+iHLIyZ2we7bhBtjAO8bq+y1poPU4a52Y9By6wmH4Ee/aJjbV/J6ZQgNIs1fWMLgvABzTVnNpqt7/nn6OQSksU7I6kkYUqq4xzndFvxdvUP6tqCxotjmyA3YUGKYe7iTBBXiFQB3t40gnoOH3Y/Ys3Fuy8MolB8FENRS8scWed0bphVQBP1DAQ9U6EaGbDSZCdzbQa+95SiWR1wOwUmhcOTQJ5NvxtKMaXbGayyNrm0rxEkrWFX9KkksktXKDozAVroeG1dYnBwb0QYxCWvcVfwNm6h5DdG2JGGYRghaOM5XBmeOJ2IuN9Wyo3PEujI73eL+AF2Payj7hWbx4Sa8C84BJioA7FBT928uafFhjjRuPzVFh9Hvt7h6dt/cdtp8itzWcGQZWSnigpPvpvdlY7EIelIitcuSbB/N+T1NxOT3AD1xULjLII6mFkx5vrWLxbWLeq6IL6YU1vpWG2zHDLuXk1s/29tZnXa3sWdkqjYLGJgDzLSYi4VY6oXkXHKy5aLUGaftY32XiHceuCTAWF2XxbLy9m6DUPzBBNxgidbQ0RGTTNqAHcXnoJzut84eLdBJd0ebIsJfAClW1tTx1wUG3u9Eu2+ny/L5UGNxZSOjoM1GgIbX3yj6h5M5punJtqOxDc1H6G0T6ZTGFyBY7A45cmlOBshaSUeY83DE0PnKa6GAidfUGOrF3gp1pAhRvJghMC2Wahls7oDRwV3GZQQsMxSOr2Aa8i8BPwj0vLAY+dN5b5lcqHfQyttNeJ1x8u4Wj6aKiTxN8GA3U+ojMMVXsQ8AwfDBRUu3XVlY0VReznB2atnHuNjiXmKdK1MLG4X4L3LYaRiViJQqQBk6q2OdvHrWlggNU5IzKUXCM9pdiuwWy9F4P6NDTl/qb6JbCkNeasG7TbrpWxaQT72paCu2tL/aK1lhVj0qNE1rU64Zx7OzyT7d8A5PRdTAby73FY26OjEuXzwtpLJfFWMtMA7KkVHl8tS7Ef2OBAY6u5cl5coHhs+jmw4k8m9SREDt0bnwyy8Sb7rOVXr3iWj3Kzk9l08+RJqNFdvLS4yzHdYEpGcHi9KvaPFHlMyFZ57p9yiYM21Rc3lIMgaKNKDKq4SXfAea5nQXHn8ZOjSZPhjIc5Eq8Er8CC68hodNWCV8WddaKV+2lNfZNT6zpP+gkxENdN+6M8NvpCc9krUqxPQbjKWN/gc2sX9E9YL0ldnEoN99PDPqeH8N3IOT++RUWC4bu5p7Y33cLQngtlJRQOAMIfbphcuH47ghVwtUo5vsgC9SHiLHunEO6oyMbKDTY8d7g1vD1i/m+AxudhWI/3Dek0L6pdLfHtU27qYShDtHktjvY7JW6Ze7BEYMA1SbYWnr96hXr3gOfIO/VGZuojtCEnMnO0eNMBVh0vSHVGupG1FFwjcyu8h3Fj2hq4DyDQynQwzgVCC2F3i+iVBqOH6i4PLnnrQagmT4EiXvcdIzTBa/jtI52dFJDFkU55tKtgWrL9sqgRNFXnnpIXh6Q89Ilp1Pxt8VeEJp8VN25YNan6RLoE27xKRHfegx5tlsWXaJqrcFUIv5YnOz3w4Oc4YmvuYjnanXDsFsfl9it7J1Ro0JXlPnXg9GBqY9cKWo0hbSerreLtRijQ7+OZvx1UXJB4WdUI8Q9MWpTTbTE0N/5Z0aSdJ9pRCW/OyU13fArmIX5V4pQ9oQlnR0GgdKm7sR9sHFKHHoTogbV2j77633cEy2lk54Sic8q5gjEd9cFL8Nq3jTORNA+q66r1a3FBULuXAZlsA9LDmrQkH9yvWyranp913IYrA8fD4VZxQvYq6qk9IVZqBvM8+LuzjCx9J0jWehjQ1ZXYQO2UjshSRzUJ8WhvoE91aEAvBKnaQ584DIT2tqRCEyGcsCNkmdxQcCJlXLJKI+kVX0YqmvucsJud+S4jtBviSJLpwpWVTuArsDuvGH4/pirrdi1OhrupfD01ui7w0cE1/IuomedQRXvo0A4DIqic7UhH6PWBDdG7CSlRmRGpAdhpXl2aaPFAf14WG25uR02t7oBIYXZw2BMNVTcD3KxHchiWLaQJwmVjvcehHFAVrCoksx5KWOU7xvBvS9BusvCOed+5FYxDVYLOKCvixfgA4PfHxor3b5vNj9wVcGlf4mg7F/7YXoICtpaqpqLsMH9EQUW8nYmpNmTPYh4geRYt4x7FdGC6OFv2OLvX42CR3YZMqWoo6PFCYVRIcr2OcVWQEX1bOTW/J4N9GkpvmiziY5LP9RvotqJNkS3Hp1rJLw+JcYJ5262Shc+gJD69C6gNUAHocbIUHRYLAEv3RsqRB0E9H57YNsWmenjjzMN6VIbVJ7+CNQhUTvA2g8Za6DoMhhBNx3RGFKMWxfevJ5Jmxg1N81UbYvv9GVbeVHEMS6iSaPMauESEzfqwAZdWkYpmBdUlBAMPuhtkwi5pB77ZKgkJCS+w59ilLS4i27do12rjdIEBQhQgWdhgR4OMAABLtFVXnmEHyJRyvxx9u8DFfxb2SOQ5eNNAGZ8dwrM+Dx8EP4XkBljDESCXCTIRYJcJMhFglwkyEWCXCTIRYJcJMhFglwkyEWCXCTIRYJcJMhFglwkyEWCXCTIRYJcJMhFglwkyEWCXCTIRYJcJMhFglwkyEWCXCTIxX8H5OL7U8jFuwic8C/gLZ5+mO//Txhx0+0l9h/S/wkjwTISLCPBMhIsI8EyEiwjwTISLCPBMhIsI8EyEiwjwTISLCPBMhIsI8EyEiwjwTISLCPBMhIsI8EyEiwjwTISLCPBMhIsI8EyEiwjwTL+W2AZP5zCMi6Vzd6FGPnHYRmTz+nhHJgqJABGAmAkAEYCYCQARgJgJABGAmAkAEYCYCQARgJgJABGAmAkAEYCYCQARgJgJABGAmAkAEYCYCQARgJgJABGAmAkAEYCYCQARgJgJABGAmD85wMwHrGoL1qNlSaCIBaNeA/Hlfwb8BJ0Pv9yg6cIo//bgj5+Qj7CzE93dk39Uvz7ZjbCcbyl3mmGfSxKS6mlOc8bZXw7eZ/P87PD67PQjzp78L9W5eOZsVzbF5QuvfiqNmeuE/vCU8OyFkt65BofXOf53trGzM/OeNO8dIHypVD5mKcf6bnVQpk5ChluRtaDHK4RUeLuoj9dJ1z8CHX8cFE+zzfANdmb+/HOZXnz/Ke/r/HSrrGt/DSZIWu0OPvp7+uMQkImTBb0J9sqnRmQRqADzrreu8lQlzP0qdmem8yAzV6/W7zMflZtVnCZqY3lQmZmRPogePZPlDzuPNt5mbygZS9oyT8zkGWjhLQvszetzTaQFVzDtq3+lPWM0rncl2msUXegzZ9+h4TGGterN014f53P83+8WHxavXjvoTAoQ7cjohHr5ymdobBX9s8mk8pmGtyDZAllZhWKMlt8WqHSZkJmvyDJjGxvlhkhC8iEJcluIKP6vcRlldqZlz2v/DYwSftztDOsjK7ccxsa4LKHK93CcVWiJr9CN4TZArHvTXdNqow8nZzBT32quMXyIrtaXq+JeQ1UwFDXB63ELT989/IVeRJlbM1JHT2/Q0MdfKSTIz6enjUVJhOPM2dyD96Gv+SH132XDknMOztGVRgaMn2hN+WbWY4lM1J5eMBe7WddPT7isJPd/MsNviFpQWgANPcuLs+3vDJwwnAHGcv/cuXt569ZPps+SNASeXRPVS3+5cp8dFXdMR7xbvbBLT74+XP3qRfr7qmrdTo3Qqqhr3Q7FvS28s21N5Gv/PTxeo22gy57/pDXHtnG76ifd+d4VXR0clk09tC1A/N57miiBmLuMTQM90Lsf+CpJqURW547BP4XjzS5/OHBmdzjY7feTT25w4s1rMaLwej0/+2F7Bg=
post api-method
api//tolgee-api

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; import ParamsDetails from "@theme/ParamsDetails"; import RequestSchema from "@theme/RequestSchema"; import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading";

<Heading as={"h1"} className={"openapi__heading"} children={"Delete keys"}

<MethodEndpoint method={"post"} path={"/v2/projects/{projectId}/start-batch-job/delete-keys"} context={"endpoint"}

Delete keys

<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}

<ParamsDetails parameters={[{"name":"projectId","in":"path","required":true,"allowEmptyValue":false,"schema":{"type":"integer","format":"int64"}}]}

<RequestSchema title={"Body"} body={{"content":{"application/json":{"schema":{"required":["keyIds"],"type":"object","properties":{"keyIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"DeleteKeysRequest"}}},"required":true}}

<StatusCodes id={undefined} label={undefined} responses={{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["createdAt","id","progress","status","totalItems","type","updatedAt"],"type":"object","properties":{"activityRevisionId":{"type":"integer","description":"The activity revision id, that stores the activity details of the job","format":"int64"},"author":{"required":["deleted","id","username"],"type":"object","properties":{"avatar":{"required":["large","thumbnail"],"type":"object","properties":{"large":{"type":"string"},"thumbnail":{"type":"string"}},"example":"Links to avatar images","title":"Avatar"},"deleted":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"username":{"type":"string"}},"title":"SimpleUserAccountModel"},"createdAt":{"type":"integer","description":"The time when the job created","format":"int64"},"errorMessage":{"type":"string","description":"If the job failed, this is the error message"},"id":{"type":"integer","description":"Batch job id","format":"int64"},"progress":{"type":"integer","description":"Total items, that have been processed so far","format":"int32"},"status":{"type":"string","description":"Status of the batch job","enum":["PENDING","RUNNING","SUCCESS","FAILED","CANCELLED","DEBOUNCED"]},"totalItems":{"type":"integer","description":"Total items","format":"int32"},"type":{"type":"string","description":"Type of the batch job","enum":["PRE_TRANSLATE_BT_TM","MACHINE_TRANSLATE","AUTO_TRANSLATE","DELETE_KEYS","SET_TRANSLATIONS_STATE","CLEAR_TRANSLATIONS","COPY_TRANSLATIONS","TAG_KEYS","UNTAG_KEYS","SET_KEYS_NAMESPACE","AUTOMATION","BILLING_TRIAL_EXPIRATION_NOTICE"]},"updatedAt":{"type":"integer","description":"The time when the job was last updated (status change)","format":"int64"}},"title":"BatchJobModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"example":{"code":"you_did_something_wrong","params":["something","wrong"]},"oneOf":[{"required":["code"],"type":"object","properties":{"code":{"type":"string","enum":["unauthenticated","api_access_forbidden","api_key_not_found","invalid_api_key","invalid_project_api_key","project_api_key_expired","bad_credentials","mfa_enabled","invalid_otp_code","mfa_not_enabled","can_not_revoke_own_permissions","data_corrupted","invitation_code_does_not_exist_or_expired","language_tag_exists","language_name_exists","language_not_found","operation_not_permitted","registrations_not_allowed","project_not_found","resource_not_found","scope_not_found","key_exists","third_party_auth_error_message","third_party_auth_no_email","third_party_auth_non_matching_email","third_party_auth_no_sub","third_party_auth_unknown_error","email_already_verified","third_party_unauthorized","third_party_google_workspace_mismatch","third_party_switch_initiated","third_party_switch_conflict","username_already_exists","username_or_password_invalid","user_already_has_permissions","user_already_has_role","user_not_found","file_not_image","file_too_big","invalid_timestamp","email_not_verified","missing_callback_url","invalid_jwt_token","expired_jwt_token","general_jwt_error","cannot_find_suitable_address_part","slug_not_unique","user_is_not_member_of_organization","organization_has_no_other_owner","user_has_no_project_access","user_is_organization_owner","cannot_set_your_own_permissions","user_is_organization_member","property_not_mutable","import_language_not_from_project","existing_language_not_selected","conflict_is_not_resolved","language_already_selected","cannot_parse_file","could_not_resolve_property","cannot_add_more_then_100_languages","no_languages_provided","language_with_base_language_tag_not_found","language_not_from_project","namespace_not_from_project","cannot_delete_base_language","key_not_from_project","max_screenshots_exceeded","translation_not_from_project","can_edit_only_own_comment","request_parse_error","filter_by_value_state_not_valid","import_has_expired","tag_not_from_project","translation_text_too_long","invalid_recaptcha_token","cannot_leave_owning_project","cannot_leave_project_with_organization_role","dont_have_direct_permissions","tag_too_log","too_many_uploaded_images","one_or_more_images_not_found","screenshot_not_of_key","service_not_found","too_many_requests","translation_not_found","out_of_credits","key_not_found","organization_not_found","cannot_find_base_language","base_language_not_found","no_exported_result","cannot_set_your_own_role","only_translate_review_or_view_permission_accepts_view_languages","oauth2_token_url_not_set","oauth2_user_url_not_set","email_already_invited_or_member","price_not_found","invoice_not_from_organization","invoice_not_found","plan_not_found","plan_not_available_any_more","no_auto_translation_method","cannot_translate_base_language","pat_not_found","invalid_pat","pat_expired","operation_unavailable_for_account_type","validation_email_is_not_valid","current_password_required","cannot_create_organization","wrong_current_password","wrong_param_type","user_missing_password","expired_super_jwt_token","cannot_delete_your_own_account","cannot_sort_by_this_column","namespace_not_found","namespace_exists","invalid_authentication_method","unknown_sort_property","only_review_permission_accepts_state_change_languages","only_translate_or_review_permission_accepts_translate_languages","cannot_set_language_permissions_for_admin_scope","cannot_set_view_languages_without_translations_view_scope","cannot_set_translate_languages_without_translations_edit_scope","cannot_set_state_change_languages_without_translations_state_edit_scope","language_not_permitted","scopes_has_to_be_set","set_exactly_one_of_scopes_or_type","translation_exists","import_keys_error","provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids","multiple_projects_not_supported","plan_translation_limit_exceeded","feature_not_enabled","license_key_not_found","cannot_set_view_languages_without_for_level_based_permissions","cannot_set_different_translate_and_state_change_languages_for_level_based_permissions","cannot_disable_your_own_account","subscription_not_found","invoice_does_not_have_usage","customer_not_found","subscription_not_active","organization_already_subscribed","organization_not_subscribed","license_key_used_by_another_instance","translation_spending_limit_exceeded","credit_spending_limit_exceeded","seats_spending_limit_exceeded","this_instance_is_already_licensed","big_meta_not_from_project","mt_service_not_enabled","project_not_selected","organization_not_selected","plan_has_subscribers","translation_failed","batch_job_not_found","key_exists_in_namespace","tag_is_blank","execution_failed_on_management_error","translation_api_rate_limit","cannot_finalize_activity","formality_not_supported_by_service","language_not_supported_by_service","rate_limited","pat_access_not_allowed","pak_access_not_allowed","cannot_modify_disabled_translation","azure_config_required","s3_config_required","content_storage_config_required","content_storage_test_failed","content_storage_config_invalid","invalid_connection_string","cannot_create_azure_storage_client","s3_access_key_required","azure_connection_string_required","s3_secret_key_required","cannot_store_file_to_content_storage","unexpected_error_while_publishing_to_content_storage","webhook_responded_with_non_200_status","unexpected_error_while_executing_webhook","content_storage_is_in_use","cannot_set_state_for_missing_translation","no_project_id_provided","license_key_not_provided","subscription_already_canceled","user_is_subscribed_to_paid_plan","cannot_create_free_plan_without_fixed_type","cannot_modify_plan_free_status","key_id_not_provided","free_self_hosted_seat_limit_exceeded","advanced_params_not_supported","plural_forms_not_found_for_language","nested_plurals_not_supported","message_is_not_plural","content_outside_plural_forms","invalid_plural_form","multiple_plurals_not_supported","custom_values_json_too_long","unsupported_po_message_format","plural_forms_data_loss","current_user_does_not_own_image","user_cannot_view_this_organization","user_is_not_owner_of_organization","pak_created_for_different_project","custom_slug_is_only_applicable_for_custom_storage","invalid_slug_format","batch_job_cancellation_timeout","import_failed","cannot_add_more_then_1000_languages","no_data_to_import","multiple_namespaces_mapped_to_single_file","multiple_mappings_for_same_file_language_name","multiple_mappings_for_null_file_language_name","too_many_mappings_for_file","missing_placeholder_in_template","tag_not_found","cannot_parse_encrypted_slack_login_data","slack_workspace_not_found","cannot_fetch_user_details_from_slack","slack_missing_scope","slack_not_connected_to_your_account","slack_invalid_command","slack_not_subscribed_yet","slack_connection_failed","tolgee_account_already_connected","slack_not_configured","slack_workspace_already_connected","slack_connection_error","email_verification_code_not_valid","cannot_subscribe_to_free_plan","plan_auto_assignment_only_for_free_plans","plan_auto_assignment_only_for_private_plans","task_not_found","task_not_finished","task_not_open","translation_agency_not_found","this_feature_is_not_implemented_in_oss","sso_token_exchange_failed","sso_user_info_retrieval_failed","sso_id_token_expired","sso_user_cannot_create_organization","sso_cant_verify_user","sso_auth_missing_domain","sso_domain_not_found_or_disabled","authentication_method_disabled","native_authentication_disabled","invitation_organization_mismatch","user_is_managed_by_organization","cannot_set_sso_provider_missing_fields","namespaces_cannot_be_disabled_when_namespace_exists","namespace_cannot_be_used_when_feature_is_disabled","sso_domain_not_allowed","sso_login_forced_for_this_account","use_sso_for_authentication_instead","date_has_to_be_in_the_future","custom_plan_and_plan_id_cannot_be_set_together","specify_plan_id_or_custom_plan","custom_plans_has_to_be_private","cannot_create_free_plan_with_prices","subscription_not_scheduled_for_cancellation","cannot_cancel_trial","cannot_update_without_modification","current_subscription_is_not_trialing","sorting_and_paging_is_not_supported_when_using_cursor"]},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseTyped"},{"required":["code"],"type":"object","properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseBody"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"example":{"code":"unauthenticated"},"oneOf":[{"required":["code"],"type":"object","properties":{"code":{"type":"string","enum":["unauthenticated","api_access_forbidden","api_key_not_found","invalid_api_key","invalid_project_api_key","project_api_key_expired","bad_credentials","mfa_enabled","invalid_otp_code","mfa_not_enabled","can_not_revoke_own_permissions","data_corrupted","invitation_code_does_not_exist_or_expired","language_tag_exists","language_name_exists","language_not_found","operation_not_permitted","registrations_not_allowed","project_not_found","resource_not_found","scope_not_found","key_exists","third_party_auth_error_message","third_party_auth_no_email","third_party_auth_non_matching_email","third_party_auth_no_sub","third_party_auth_unknown_error","email_already_verified","third_party_unauthorized","third_party_google_workspace_mismatch","third_party_switch_initiated","third_party_switch_conflict","username_already_exists","username_or_password_invalid","user_already_has_permissions","user_already_has_role","user_not_found","file_not_image","file_too_big","invalid_timestamp","email_not_verified","missing_callback_url","invalid_jwt_token","expired_jwt_token","general_jwt_error","cannot_find_suitable_address_part","slug_not_unique","user_is_not_member_of_organization","organization_has_no_other_owner","user_has_no_project_access","user_is_organization_owner","cannot_set_your_own_permissions","user_is_organization_member","property_not_mutable","import_language_not_from_project","existing_language_not_selected","conflict_is_not_resolved","language_already_selected","cannot_parse_file","could_not_resolve_property","cannot_add_more_then_100_languages","no_languages_provided","language_with_base_language_tag_not_found","language_not_from_project","namespace_not_from_project","cannot_delete_base_language","key_not_from_project","max_screenshots_exceeded","translation_not_from_project","can_edit_only_own_comment","request_parse_error","filter_by_value_state_not_valid","import_has_expired","tag_not_from_project","translation_text_too_long","invalid_recaptcha_token","cannot_leave_owning_project","cannot_leave_project_with_organization_role","dont_have_direct_permissions","tag_too_log","too_many_uploaded_images","one_or_more_images_not_found","screenshot_not_of_key","service_not_found","too_many_requests","translation_not_found","out_of_credits","key_not_found","organization_not_found","cannot_find_base_language","base_language_not_found","no_exported_result","cannot_set_your_own_role","only_translate_review_or_view_permission_accepts_view_languages","oauth2_token_url_not_set","oauth2_user_url_not_set","email_already_invited_or_member","price_not_found","invoice_not_from_organization","invoice_not_found","plan_not_found","plan_not_available_any_more","no_auto_translation_method","cannot_translate_base_language","pat_not_found","invalid_pat","pat_expired","operation_unavailable_for_account_type","validation_email_is_not_valid","current_password_required","cannot_create_organization","wrong_current_password","wrong_param_type","user_missing_password","expired_super_jwt_token","cannot_delete_your_own_account","cannot_sort_by_this_column","namespace_not_found","namespace_exists","invalid_authentication_method","unknown_sort_property","only_review_permission_accepts_state_change_languages","only_translate_or_review_permission_accepts_translate_languages","cannot_set_language_permissions_for_admin_scope","cannot_set_view_languages_without_translations_view_scope","cannot_set_translate_languages_without_translations_edit_scope","cannot_set_state_change_languages_without_translations_state_edit_scope","language_not_permitted","scopes_has_to_be_set","set_exactly_one_of_scopes_or_type","translation_exists","import_keys_error","provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids","multiple_projects_not_supported","plan_translation_limit_exceeded","feature_not_enabled","license_key_not_found","cannot_set_view_languages_without_for_level_based_permissions","cannot_set_different_translate_and_state_change_languages_for_level_based_permissions","cannot_disable_your_own_account","subscription_not_found","invoice_does_not_have_usage","customer_not_found","subscription_not_active","organization_already_subscribed","organization_not_subscribed","license_key_used_by_another_instance","translation_spending_limit_exceeded","credit_spending_limit_exceeded","seats_spending_limit_exceeded","this_instance_is_already_licensed","big_meta_not_from_project","mt_service_not_enabled","project_not_selected","organization_not_selected","plan_has_subscribers","translation_failed","batch_job_not_found","key_exists_in_namespace","tag_is_blank","execution_failed_on_management_error","translation_api_rate_limit","cannot_finalize_activity","formality_not_supported_by_service","language_not_supported_by_service","rate_limited","pat_access_not_allowed","pak_access_not_allowed","cannot_modify_disabled_translation","azure_config_required","s3_config_required","content_storage_config_required","content_storage_test_failed","content_storage_config_invalid","invalid_connection_string","cannot_create_azure_storage_client","s3_access_key_required","azure_connection_string_required","s3_secret_key_required","cannot_store_file_to_content_storage","unexpected_error_while_publishing_to_content_storage","webhook_responded_with_non_200_status","unexpected_error_while_executing_webhook","content_storage_is_in_use","cannot_set_state_for_missing_translation","no_project_id_provided","license_key_not_provided","subscription_already_canceled","user_is_subscribed_to_paid_plan","cannot_create_free_plan_without_fixed_type","cannot_modify_plan_free_status","key_id_not_provided","free_self_hosted_seat_limit_exceeded","advanced_params_not_supported","plural_forms_not_found_for_language","nested_plurals_not_supported","message_is_not_plural","content_outside_plural_forms","invalid_plural_form","multiple_plurals_not_supported","custom_values_json_too_long","unsupported_po_message_format","plural_forms_data_loss","current_user_does_not_own_image","user_cannot_view_this_organization","user_is_not_owner_of_organization","pak_created_for_different_project","custom_slug_is_only_applicable_for_custom_storage","invalid_slug_format","batch_job_cancellation_timeout","import_failed","cannot_add_more_then_1000_languages","no_data_to_import","multiple_namespaces_mapped_to_single_file","multiple_mappings_for_same_file_language_name","multiple_mappings_for_null_file_language_name","too_many_mappings_for_file","missing_placeholder_in_template","tag_not_found","cannot_parse_encrypted_slack_login_data","slack_workspace_not_found","cannot_fetch_user_details_from_slack","slack_missing_scope","slack_not_connected_to_your_account","slack_invalid_command","slack_not_subscribed_yet","slack_connection_failed","tolgee_account_already_connected","slack_not_configured","slack_workspace_already_connected","slack_connection_error","email_verification_code_not_valid","cannot_subscribe_to_free_plan","plan_auto_assignment_only_for_free_plans","plan_auto_assignment_only_for_private_plans","task_not_found","task_not_finished","task_not_open","translation_agency_not_found","this_feature_is_not_implemented_in_oss","sso_token_exchange_failed","sso_user_info_retrieval_failed","sso_id_token_expired","sso_user_cannot_create_organization","sso_cant_verify_user","sso_auth_missing_domain","sso_domain_not_found_or_disabled","authentication_method_disabled","native_authentication_disabled","invitation_organization_mismatch","user_is_managed_by_organization","cannot_set_sso_provider_missing_fields","namespaces_cannot_be_disabled_when_namespace_exists","namespace_cannot_be_used_when_feature_is_disabled","sso_domain_not_allowed","sso_login_forced_for_this_account","use_sso_for_authentication_instead","date_has_to_be_in_the_future","custom_plan_and_plan_id_cannot_be_set_together","specify_plan_id_or_custom_plan","custom_plans_has_to_be_private","cannot_create_free_plan_with_prices","subscription_not_scheduled_for_cancellation","cannot_cancel_trial","cannot_update_without_modification","current_subscription_is_not_trialing","sorting_and_paging_is_not_supported_when_using_cursor"]},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseTyped"},{"required":["code"],"type":"object","properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseBody"}]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"example":{"code":"operation_not_permitted","params":["translations.edit"]},"oneOf":[{"required":["code"],"type":"object","properties":{"code":{"type":"string","enum":["unauthenticated","api_access_forbidden","api_key_not_found","invalid_api_key","invalid_project_api_key","project_api_key_expired","bad_credentials","mfa_enabled","invalid_otp_code","mfa_not_enabled","can_not_revoke_own_permissions","data_corrupted","invitation_code_does_not_exist_or_expired","language_tag_exists","language_name_exists","language_not_found","operation_not_permitted","registrations_not_allowed","project_not_found","resource_not_found","scope_not_found","key_exists","third_party_auth_error_message","third_party_auth_no_email","third_party_auth_non_matching_email","third_party_auth_no_sub","third_party_auth_unknown_error","email_already_verified","third_party_unauthorized","third_party_google_workspace_mismatch","third_party_switch_initiated","third_party_switch_conflict","username_already_exists","username_or_password_invalid","user_already_has_permissions","user_already_has_role","user_not_found","file_not_image","file_too_big","invalid_timestamp","email_not_verified","missing_callback_url","invalid_jwt_token","expired_jwt_token","general_jwt_error","cannot_find_suitable_address_part","slug_not_unique","user_is_not_member_of_organization","organization_has_no_other_owner","user_has_no_project_access","user_is_organization_owner","cannot_set_your_own_permissions","user_is_organization_member","property_not_mutable","import_language_not_from_project","existing_language_not_selected","conflict_is_not_resolved","language_already_selected","cannot_parse_file","could_not_resolve_property","cannot_add_more_then_100_languages","no_languages_provided","language_with_base_language_tag_not_found","language_not_from_project","namespace_not_from_project","cannot_delete_base_language","key_not_from_project","max_screenshots_exceeded","translation_not_from_project","can_edit_only_own_comment","request_parse_error","filter_by_value_state_not_valid","import_has_expired","tag_not_from_project","translation_text_too_long","invalid_recaptcha_token","cannot_leave_owning_project","cannot_leave_project_with_organization_role","dont_have_direct_permissions","tag_too_log","too_many_uploaded_images","one_or_more_images_not_found","screenshot_not_of_key","service_not_found","too_many_requests","translation_not_found","out_of_credits","key_not_found","organization_not_found","cannot_find_base_language","base_language_not_found","no_exported_result","cannot_set_your_own_role","only_translate_review_or_view_permission_accepts_view_languages","oauth2_token_url_not_set","oauth2_user_url_not_set","email_already_invited_or_member","price_not_found","invoice_not_from_organization","invoice_not_found","plan_not_found","plan_not_available_any_more","no_auto_translation_method","cannot_translate_base_language","pat_not_found","invalid_pat","pat_expired","operation_unavailable_for_account_type","validation_email_is_not_valid","current_password_required","cannot_create_organization","wrong_current_password","wrong_param_type","user_missing_password","expired_super_jwt_token","cannot_delete_your_own_account","cannot_sort_by_this_column","namespace_not_found","namespace_exists","invalid_authentication_method","unknown_sort_property","only_review_permission_accepts_state_change_languages","only_translate_or_review_permission_accepts_translate_languages","cannot_set_language_permissions_for_admin_scope","cannot_set_view_languages_without_translations_view_scope","cannot_set_translate_languages_without_translations_edit_scope","cannot_set_state_change_languages_without_translations_state_edit_scope","language_not_permitted","scopes_has_to_be_set","set_exactly_one_of_scopes_or_type","translation_exists","import_keys_error","provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids","multiple_projects_not_supported","plan_translation_limit_exceeded","feature_not_enabled","license_key_not_found","cannot_set_view_languages_without_for_level_based_permissions","cannot_set_different_translate_and_state_change_languages_for_level_based_permissions","cannot_disable_your_own_account","subscription_not_found","invoice_does_not_have_usage","customer_not_found","subscription_not_active","organization_already_subscribed","organization_not_subscribed","license_key_used_by_another_instance","translation_spending_limit_exceeded","credit_spending_limit_exceeded","seats_spending_limit_exceeded","this_instance_is_already_licensed","big_meta_not_from_project","mt_service_not_enabled","project_not_selected","organization_not_selected","plan_has_subscribers","translation_failed","batch_job_not_found","key_exists_in_namespace","tag_is_blank","execution_failed_on_management_error","translation_api_rate_limit","cannot_finalize_activity","formality_not_supported_by_service","language_not_supported_by_service","rate_limited","pat_access_not_allowed","pak_access_not_allowed","cannot_modify_disabled_translation","azure_config_required","s3_config_required","content_storage_config_required","content_storage_test_failed","content_storage_config_invalid","invalid_connection_string","cannot_create_azure_storage_client","s3_access_key_required","azure_connection_string_required","s3_secret_key_required","cannot_store_file_to_content_storage","unexpected_error_while_publishing_to_content_storage","webhook_responded_with_non_200_status","unexpected_error_while_executing_webhook","content_storage_is_in_use","cannot_set_state_for_missing_translation","no_project_id_provided","license_key_not_provided","subscription_already_canceled","user_is_subscribed_to_paid_plan","cannot_create_free_plan_without_fixed_type","cannot_modify_plan_free_status","key_id_not_provided","free_self_hosted_seat_limit_exceeded","advanced_params_not_supported","plural_forms_not_found_for_language","nested_plurals_not_supported","message_is_not_plural","content_outside_plural_forms","invalid_plural_form","multiple_plurals_not_supported","custom_values_json_too_long","unsupported_po_message_format","plural_forms_data_loss","current_user_does_not_own_image","user_cannot_view_this_organization","user_is_not_owner_of_organization","pak_created_for_different_project","custom_slug_is_only_applicable_for_custom_storage","invalid_slug_format","batch_job_cancellation_timeout","import_failed","cannot_add_more_then_1000_languages","no_data_to_import","multiple_namespaces_mapped_to_single_file","multiple_mappings_for_same_file_language_name","multiple_mappings_for_null_file_language_name","too_many_mappings_for_file","missing_placeholder_in_template","tag_not_found","cannot_parse_encrypted_slack_login_data","slack_workspace_not_found","cannot_fetch_user_details_from_slack","slack_missing_scope","slack_not_connected_to_your_account","slack_invalid_command","slack_not_subscribed_yet","slack_connection_failed","tolgee_account_already_connected","slack_not_configured","slack_workspace_already_connected","slack_connection_error","email_verification_code_not_valid","cannot_subscribe_to_free_plan","plan_auto_assignment_only_for_free_plans","plan_auto_assignment_only_for_private_plans","task_not_found","task_not_finished","task_not_open","translation_agency_not_found","this_feature_is_not_implemented_in_oss","sso_token_exchange_failed","sso_user_info_retrieval_failed","sso_id_token_expired","sso_user_cannot_create_organization","sso_cant_verify_user","sso_auth_missing_domain","sso_domain_not_found_or_disabled","authentication_method_disabled","native_authentication_disabled","invitation_organization_mismatch","user_is_managed_by_organization","cannot_set_sso_provider_missing_fields","namespaces_cannot_be_disabled_when_namespace_exists","namespace_cannot_be_used_when_feature_is_disabled","sso_domain_not_allowed","sso_login_forced_for_this_account","use_sso_for_authentication_instead","date_has_to_be_in_the_future","custom_plan_and_plan_id_cannot_be_set_together","specify_plan_id_or_custom_plan","custom_plans_has_to_be_private","cannot_create_free_plan_with_prices","subscription_not_scheduled_for_cancellation","cannot_cancel_trial","cannot_update_without_modification","current_subscription_is_not_trialing","sorting_and_paging_is_not_supported_when_using_cursor"]},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseTyped"},{"required":["code"],"type":"object","properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseBody"}]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"example":{"code":"resource_not_found","params":null},"oneOf":[{"required":["code"],"type":"object","properties":{"code":{"type":"string","enum":["unauthenticated","api_access_forbidden","api_key_not_found","invalid_api_key","invalid_project_api_key","project_api_key_expired","bad_credentials","mfa_enabled","invalid_otp_code","mfa_not_enabled","can_not_revoke_own_permissions","data_corrupted","invitation_code_does_not_exist_or_expired","language_tag_exists","language_name_exists","language_not_found","operation_not_permitted","registrations_not_allowed","project_not_found","resource_not_found","scope_not_found","key_exists","third_party_auth_error_message","third_party_auth_no_email","third_party_auth_non_matching_email","third_party_auth_no_sub","third_party_auth_unknown_error","email_already_verified","third_party_unauthorized","third_party_google_workspace_mismatch","third_party_switch_initiated","third_party_switch_conflict","username_already_exists","username_or_password_invalid","user_already_has_permissions","user_already_has_role","user_not_found","file_not_image","file_too_big","invalid_timestamp","email_not_verified","missing_callback_url","invalid_jwt_token","expired_jwt_token","general_jwt_error","cannot_find_suitable_address_part","slug_not_unique","user_is_not_member_of_organization","organization_has_no_other_owner","user_has_no_project_access","user_is_organization_owner","cannot_set_your_own_permissions","user_is_organization_member","property_not_mutable","import_language_not_from_project","existing_language_not_selected","conflict_is_not_resolved","language_already_selected","cannot_parse_file","could_not_resolve_property","cannot_add_more_then_100_languages","no_languages_provided","language_with_base_language_tag_not_found","language_not_from_project","namespace_not_from_project","cannot_delete_base_language","key_not_from_project","max_screenshots_exceeded","translation_not_from_project","can_edit_only_own_comment","request_parse_error","filter_by_value_state_not_valid","import_has_expired","tag_not_from_project","translation_text_too_long","invalid_recaptcha_token","cannot_leave_owning_project","cannot_leave_project_with_organization_role","dont_have_direct_permissions","tag_too_log","too_many_uploaded_images","one_or_more_images_not_found","screenshot_not_of_key","service_not_found","too_many_requests","translation_not_found","out_of_credits","key_not_found","organization_not_found","cannot_find_base_language","base_language_not_found","no_exported_result","cannot_set_your_own_role","only_translate_review_or_view_permission_accepts_view_languages","oauth2_token_url_not_set","oauth2_user_url_not_set","email_already_invited_or_member","price_not_found","invoice_not_from_organization","invoice_not_found","plan_not_found","plan_not_available_any_more","no_auto_translation_method","cannot_translate_base_language","pat_not_found","invalid_pat","pat_expired","operation_unavailable_for_account_type","validation_email_is_not_valid","current_password_required","cannot_create_organization","wrong_current_password","wrong_param_type","user_missing_password","expired_super_jwt_token","cannot_delete_your_own_account","cannot_sort_by_this_column","namespace_not_found","namespace_exists","invalid_authentication_method","unknown_sort_property","only_review_permission_accepts_state_change_languages","only_translate_or_review_permission_accepts_translate_languages","cannot_set_language_permissions_for_admin_scope","cannot_set_view_languages_without_translations_view_scope","cannot_set_translate_languages_without_translations_edit_scope","cannot_set_state_change_languages_without_translations_state_edit_scope","language_not_permitted","scopes_has_to_be_set","set_exactly_one_of_scopes_or_type","translation_exists","import_keys_error","provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids","multiple_projects_not_supported","plan_translation_limit_exceeded","feature_not_enabled","license_key_not_found","cannot_set_view_languages_without_for_level_based_permissions","cannot_set_different_translate_and_state_change_languages_for_level_based_permissions","cannot_disable_your_own_account","subscription_not_found","invoice_does_not_have_usage","customer_not_found","subscription_not_active","organization_already_subscribed","organization_not_subscribed","license_key_used_by_another_instance","translation_spending_limit_exceeded","credit_spending_limit_exceeded","seats_spending_limit_exceeded","this_instance_is_already_licensed","big_meta_not_from_project","mt_service_not_enabled","project_not_selected","organization_not_selected","plan_has_subscribers","translation_failed","batch_job_not_found","key_exists_in_namespace","tag_is_blank","execution_failed_on_management_error","translation_api_rate_limit","cannot_finalize_activity","formality_not_supported_by_service","language_not_supported_by_service","rate_limited","pat_access_not_allowed","pak_access_not_allowed","cannot_modify_disabled_translation","azure_config_required","s3_config_required","content_storage_config_required","content_storage_test_failed","content_storage_config_invalid","invalid_connection_string","cannot_create_azure_storage_client","s3_access_key_required","azure_connection_string_required","s3_secret_key_required","cannot_store_file_to_content_storage","unexpected_error_while_publishing_to_content_storage","webhook_responded_with_non_200_status","unexpected_error_while_executing_webhook","content_storage_is_in_use","cannot_set_state_for_missing_translation","no_project_id_provided","license_key_not_provided","subscription_already_canceled","user_is_subscribed_to_paid_plan","cannot_create_free_plan_without_fixed_type","cannot_modify_plan_free_status","key_id_not_provided","free_self_hosted_seat_limit_exceeded","advanced_params_not_supported","plural_forms_not_found_for_language","nested_plurals_not_supported","message_is_not_plural","content_outside_plural_forms","invalid_plural_form","multiple_plurals_not_supported","custom_values_json_too_long","unsupported_po_message_format","plural_forms_data_loss","current_user_does_not_own_image","user_cannot_view_this_organization","user_is_not_owner_of_organization","pak_created_for_different_project","custom_slug_is_only_applicable_for_custom_storage","invalid_slug_format","batch_job_cancellation_timeout","import_failed","cannot_add_more_then_1000_languages","no_data_to_import","multiple_namespaces_mapped_to_single_file","multiple_mappings_for_same_file_language_name","multiple_mappings_for_null_file_language_name","too_many_mappings_for_file","missing_placeholder_in_template","tag_not_found","cannot_parse_encrypted_slack_login_data","slack_workspace_not_found","cannot_fetch_user_details_from_slack","slack_missing_scope","slack_not_connected_to_your_account","slack_invalid_command","slack_not_subscribed_yet","slack_connection_failed","tolgee_account_already_connected","slack_not_configured","slack_workspace_already_connected","slack_connection_error","email_verification_code_not_valid","cannot_subscribe_to_free_plan","plan_auto_assignment_only_for_free_plans","plan_auto_assignment_only_for_private_plans","task_not_found","task_not_finished","task_not_open","translation_agency_not_found","this_feature_is_not_implemented_in_oss","sso_token_exchange_failed","sso_user_info_retrieval_failed","sso_id_token_expired","sso_user_cannot_create_organization","sso_cant_verify_user","sso_auth_missing_domain","sso_domain_not_found_or_disabled","authentication_method_disabled","native_authentication_disabled","invitation_organization_mismatch","user_is_managed_by_organization","cannot_set_sso_provider_missing_fields","namespaces_cannot_be_disabled_when_namespace_exists","namespace_cannot_be_used_when_feature_is_disabled","sso_domain_not_allowed","sso_login_forced_for_this_account","use_sso_for_authentication_instead","date_has_to_be_in_the_future","custom_plan_and_plan_id_cannot_be_set_together","specify_plan_id_or_custom_plan","custom_plans_has_to_be_private","cannot_create_free_plan_with_prices","subscription_not_scheduled_for_cancellation","cannot_cancel_trial","cannot_update_without_modification","current_subscription_is_not_trialing","sorting_and_paging_is_not_supported_when_using_cursor"]},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseTyped"},{"required":["code"],"type":"object","properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object"}}},"title":"ErrorResponseBody"}]}}}}}}