Tolgee Octri Demo
POST/v2/projects/{projectId}/single-step-import-resolvable

Import localization keys and translations in one request

Imports localization keys and translations from a JSON request body in a single step. Supply keys with each key's name and translations; use overrideMode to control how protected or disabled translations are handled.

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

1 parameter · 4 body fields
projectIdintegerrequired
The integer identifier of the project to import localization keys into.

Localization import data containing keys and their translations.

branchstringoptional
Branch to import keys into. If not specified, default branch is used.
errorOnUnresolvedConflictbooleanoptional
If `false`, import will apply all `non-failed` overrides and reports `unresolvedConflict` .If `true`, import will fail completely on unresolved conflict and won't apply any changes. Unresolved conflicts are reported in the `params` of the error response
keysarray<object>required
List of keys to import
overrideModestringoptional
Some translations are forbidden or protected: When set to `RECOMMENDED` it will fail for DISABLED translations and protected REVIEWED translations. When set to `ALL` it will fail for DISABLED translations, but will try to update protected REVIEWED translations (fails only if user has no permission)
Allowed:RECOMMENDEDALL

5 status codes
200Returns an object containing unresolved conflicts, with each conflict identifying the key, language, and whether it can be overridden.
unresolvedConflictsarray<object>optional
400Returned when the request is invalid, required import fields are missing, or an import 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 authentication is missing or 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
403Returned when the authenticated user does not have permission to import data into the project.
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 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 import request is invalid, a 401 when authentication is missing or invalid, a 403 when the authenticated user lacks permission, and a 404 when the project cannot be found. The projectId path parameter must identify the project to import into. keys is required, and each key must include a name of at least one character and a translations object; overrideMode, if provided, must be RECOMMENDED or ALL.