/review-cycles/:reviewCycleId/reviews/:id

Changed on

Saves (as draft) or submits the caller's answers to a review. Required scope: w_reviews. Requires a user token, or an account token with member_id, whose employee is the reviewer of the review (an account token without member_id gets 403).

The review cycle must be active and the review must not already be submitted. Only the questions listed in answers are changed; other answers are kept. With action: submit all mandatory questions must be answered and, when rating is enabled for the review type, an overall rating must be present.

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

Request

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

Path parameters

reviewCycleIdstring required

Review cycle id

idstring required

Review id, as returned in reviews[].review.id

Query parameters

member_idstring

Required when using an account token: the member (SPI key, from GET /members) whose employee is the reviewer of the review. Without it the request gets 403. Ignored for user tokens.

Request body

action'save' | 'submit' required

save stores the answers as a draft; submit stores them and submits the review

ratinginteger nullable

Overall rating of the review. When omitted, the choice of the overall rating question is used.

Response

200

Changes