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

Import localization data from files in one request

Imports localization data and its import parameters from files in a single request. Use this operation for automated imports through an API or CLI; send the files and JSON-encoded params as multipart form data.

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

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

Multipart form data containing the files to import and JSON-encoded import parameters.

filesarray<string>required
The binary files containing localization data to import.
paramsobjectrequired
Import configuration. Include `convertPlaceholdersToIcu`, `createNewKeys`, `fileMappings`, `forceMode`, `overrideKeyDescriptions`, and `tagNewKeys`. Optional settings include `branch`, `errorOnUnresolvedConflict`, `languageMappings`, `overrideMode`, `removeOtherKeys`, and `structureDelimiter`; `forceMode` accepts `OVERRIDE`, `KEEP`, or `NO_FORCE`, and `overrideMode` accepts `RECOMMENDED` or `ALL`.

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. Include files and params; params must include convertPlaceholdersToIcu, createNewKeys, fileMappings, forceMode, overrideKeyDescriptions, and tagNewKeys, and forceMode must be OVERRIDE, KEEP, or NO_FORCE.