Tolgee Octri Demo
PUT/v2/projects/{projectId}/tasks/{taskNumber}/keys

Add or remove keys from a task

Updates the keys associated with a task by adding or removing key identifiers. Supply addKeys to add keys and removeKeys to remove them; each array contains unique 64-bit integer identifiers.

2 parameters · 2 body fields
taskNumberintegerrequired
The 64-bit integer number of the task whose keys you want to update.
projectIdintegerrequired
The 64-bit integer identifier of the project containing the task.

Task key changes, with arrays of key identifiers to add or remove.

addKeysarray<integer>optional
Keys to add to task
removeKeysarray<integer>optional
Keys to remove from task

5 status codes
200Returns confirmation that the task keys were updated.
400Returned when the request is invalid, such as when a key list does not match the expected format.
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 the authenticated user is not permitted to update the task keys.
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 task does not exist.
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 is returned when the request is unauthenticated. A 403 is returned when the authenticated user cannot update the task's keys. A 404 is returned when the project or task does not exist. addKeys and removeKeys contain arrays of unique 64-bit integer key identifiers.