Marks an employee's review preparation task as ready. Required scope: w_reviews.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint uses thew_reviewsscope, which must be enabled through the Integrations section found within the Settings menu.
Requires a user token, or an account token together with the member_id query parameter. An account token without member_id gets 403 Account tokens need a member_id for this operation. The caller must be one of the following:
- the reviewee's manager, directly or higher up the reporting line
- the manager assigned to the review aggregate
- a member with permission to manage review cycles
A preparation task is one employee's review aggregate in a cycle. Marking it as ready flags the review form of every customizable review type (the types where the cycle allows manager customization) as ready. A review type with no customized form keeps the cycle's master template. Use the tasks endpoint to find the task id.
In an active cycle, you cannot mark a task as ready again once it is ready. In other cycle states, the call can be repeated.
Request body
{
"mark_as_ready": true
}| key | type | description |
|---|---|---|
| mark_as_ready | boolean | Must be true (required) |
Results
Returns 200 with an empty object.
{}Use GET /review-cycles/:reviewCycleId/employees/:employeeId or the tasks endpoint to read the updated status.
Error responses
| Status | Condition |
|---|---|
| 400 | Validation failed: mark_as_ready is missing or not true, or a path id is malformed. The body is keyed by field, e.g. {"mark_as_ready": {"code": "any.required", "message": "\"mark_as_ready\" is required"}} |
| 400 | {"message": "Review aggregate is already marked as ready"}: the cycle is active and the task is already ready |
| 401 | Missing or invalid token |
| 403 | Missing w_reviews scope, account token without member_id, or the caller is not the reviewee's manager, the aggregate's manager or a review cycle manager |
| 404 | {"message": "Review aggregate not found"}: the task does not exist, is deleted, or belongs to a different review cycle |