WOworkable

/candidates/:id/ratings

Updates or creates an evaluation for a candidate. Required scope: w_candidates. Accessible with all token types. If an evaluation already exists for the given member on the given stage, it is updated. Otherwise, a new one is created. The stage defaults to the candidate's current stage when stage_id is not provided.

put/candidates/{id}/ratings

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/candidates/{id}/ratings
  • Auth
    API key in header Authorization

Path parameters

idstring required

The candidate's id

Request body

member_idstring required

The member adding the rating

stage_idstring

The stage of the rating. If not provided this fallbacks to current stage of candidate

commentstring required

A comment about the scoring of the candidate

scale'thumbs' | 'stars' | 'numbers'

The rating scale that corresponds to the grade. One of thumbs (graphic rating), stars (star rating) or numbers (numeric rating)

gradeinteger required

The candidate grade. View details in the Grade paragraph above

scorestring

DEPRECATED One of negative, positive or definite. If the request payload includes score, the scale and grade fields are ignored

Response

OK

namestring required

Changes

No recorded changes to this operation across all 2 revisions of this API.