Tolgee Octri Demo
POST/v2/projects/{projectId}/start-batch-job/set-keys-namespace

Set a namespace for project keys

Starts an asynchronous batch job that assigns a namespace to selected keys in a project. Supply keyIds and optionally namespace to choose the keys and their namespace; the response contains the job record and its processing status.

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

1 parameter · 2 body fields
projectIdintegerrequired
The integer ID of the project whose keys to update.

Batch request to assign a namespace to selected project keys.

keyIdsarray<integer>required
The IDs of the keys to update. Must contain at least one integer.
namespacestringoptional
The namespace to assign to the selected keys. Must not exceed 100 characters.

5 status codes
200Returns the batch job record, including its ID, status, progress, total item count, job type, and timestamps.
activityRevisionIdintegeroptional
The activity revision id, that stores the activity details of the job
authorobjectoptional
createdAtintegerrequired
The time when the job created
errorMessagestringoptional
If the job failed, this is the error message
idintegerrequired
Batch job id
progressintegerrequired
Total items, that have been processed so far
statusstringrequired
Status of the batch job
Allowed:PENDINGRUNNINGSUCCESSFAILEDCANCELLED
totalItemsintegerrequired
Total items
typestringrequired
Type of the batch job
Allowed:AI_PLAYGROUND_TRANSLATEPRE_TRANSLATE_BT_TMMACHINE_TRANSLATEAUTO_TRANSLATEDELETE_KEYSRESTORE_KEYSHARD_DELETE_KEYSSET_TRANSLATIONS_STATECLEAR_TRANSLATIONSCOPY_TRANSLATIONSTAG_KEYSUNTAG_KEYS
updatedAtintegerrequired
The time when the job was last updated (status change)
400Returned when the request is invalid or 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 the request has no 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 update keys in 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 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 when the 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 is not found. keyIds must contain at least one key ID, and namespace must be no more than 100 characters. The projectId path parameter must identify an existing project.