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

Update a task key's completion status

Updates a key's completion status in a task and recalculates task progress. Set done to indicate whether the key is complete; the response reports the key's status and whether the task is finished.

3 parameters · 1 body field
taskNumberintegerrequired
The 64-bit integer number of the task containing the key.
keyIdintegerrequired
The 64-bit integer identifier of the key to update.
projectIdintegerrequired
The 64-bit integer identifier of the project containing the task.

The completion status to set for the task key.

donebooleanrequired
Whether the task key is marked as complete.

5 status codes
200Returns `done`, indicating the key's completion status, and `taskFinished`, indicating whether task progress has reached 100%.
donebooleanrequired
Task key is marked as done
taskFinishedbooleanrequired
Task progress is 100%
400Returned when `done` is missing or the request is 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
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 key.
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, task, or key 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 or done is missing. A 401 is returned when the request is unauthenticated. A 403 is returned when the authenticated user cannot update the task key. A 404 is returned when the project, task, or key does not exist. The request body must include done as a boolean.