Tolgee Octri Demo
POST/v2/projects/{projectId}/keys/import

Import localization keys and translations

Imports localization keys and their translations into a project. Provide each key's name and language-tagged translations; include optional descriptions and tags as needed. If a key already exists, its translations and tags are not updated.

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

2 parameters · 1 body field
projectIdintegerrequired
The numeric identifier of the project to import keys into.
branchstringoptional
The branch into which to import the keys.

The keys and translations to import into the project.

keysarray<object>required
The keys to import. Each key must include a non-empty `name` and a `translations` object.

5 status codes
200Confirms that the import request completed.
400Returned when the request is invalid, including when the `keys` array or a key's required fields are missing.
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 unauthenticated.
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 access to the requested resource is forbidden.
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 or requested resource 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 for a malformed request, a 401 when the request is unauthenticated, a 403 when access is forbidden, and a 404 when the project or requested resource is not found. The projectId path parameter must identify the project. The keys array is required, and each entry must include a non-empty name and translations object.