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

Changed on

Shares an employee's review aggregate (all of their reviews in the cycle) with the reviewee. Required scope: w_reviews. Requires a user token, or an account token with member_id (the share is recorded against that member; an account token without member_id gets 403). The caller must be the aggregate's manager, someone above the reviewee or the manager in the reporting line, or has the permission to manage review cycles. No request body.

The aggregate must not already be shared and the cycle must not be archived. If the cycle has a share start date it must have passed; otherwise the manager review (or, in cycles without a manager review, at least one peer or upward review) must be submitted. Non-admins can only share while the cycle is active or before the share deadline.

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

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/review-cycles/{reviewCycleId}/tasks/{id}/share
  • 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) on whose behalf the aggregate is shared. Without it the request gets 403. Ignored for user tokens.

Response

200

idstring

Review aggregate (task) id

status'not_ready' | 'draft' | 'ready'

Preparation (form customization) status

state'not_started' | 'in_progress' | 'shared' | 'signed'

Changes