WOworkable

/review-cycles/:reviewCycleId/tasks/:id

Changed on

Marks a preparation task (an employee's review aggregate) as ready, locking in the review forms for every customizable review type of that employee. Required scope: w_reviews. Requires a user token, or an account token with member_id (an account token without member_id gets 403). The caller (the user, or the member given by member_id) must be the reviewee's manager (direct or higher up the reporting line), the aggregate's assigned manager, or has the permission to manage review cycles.

The only supported body is {"mark_as_ready": true}. All reviews whose type allows manager customization are flagged as ready; reviews without a customized form keep using the cycle's master template. In an active cycle, an aggregate that is already ready cannot be marked again.

put/review-cycles/{reviewCycleId}/tasks/{id}

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/review-cycles/{reviewCycleId}/tasks/{id}
  • Auth
    API key in header Authorization

Path parameters

reviewCycleIdstring required

Review cycle id

idstring required

Task (review aggregate) id, as returned in preparation_tasks[].id / active_tasks[].id of GET /review-cycles/:reviewCycleId/tasks

Query parameters

member_idstring

Required when using an account token: the member (SPI key, from GET /members) to act as. The request is evaluated with that member's permissions; without it the request gets 403. Ignored for user tokens.

Request body

mark_as_readytrue required

Must be true

Response

200

object required

Changes