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

Changed on

Signs a shared review aggregate on behalf of the caller, as the reviewee or as the manager. Required scope: w_reviews. Requires a user token, or an account token with member_id, whose employee is the reviewee or the aggregate's manager (an account token without member_id gets 403). No request body.

The cycle must have signing enabled (a sign deadline) and must not be archived; the aggregate must already be shared and not yet signed by the caller; signing is rejected after the sign deadline and, when the cycle requires an employee meeting, until a meeting is scheduled. The aggregate becomes signed once both the reviewee and the manager have signed.

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

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/review-cycles/{reviewCycleId}/tasks/{id}/sign
  • 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) whose employee is the reviewee or the aggregate's manager. 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