GRgreenhouse
Scorecard Candidate Attributes

Create scorecard candidate attribute

Deprecated — where available, prefer the nested candidate_attributes array on POST/PATCH /v3/scorecards, which writes ratings atomically with the scorecard. This endpoint remains fully supported for existing integrations. Record an interviewer's rating on one focus attribute of one scorecard. Both scorecard_id and job_candidate_attribute_id are required, and the referenced job_candidate_attribute must be a focus attribute on the scorecard's interview kit; submitted scorecards reject new ratings. A row may carry only a note with no candidate_attribute_rating (rating defaults to no_decision).

post/v3/scorecard_candidate_attributes

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/scorecard_candidate_attributes
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:scorecard_candidate_attributes:create
    • or HTTP bearer

Request body

scorecard_idinteger required

Id of the scorecard this attribute rating attaches to. The scorecard's interview kit must include the referenced job_candidate_attribute as a focus attribute, and submitted scorecards cannot have new attribute ratings added.

candidate_attribute_rating'definitely_not' | 'no' | 'yes' | 'strong_yes' | 'mixed' | 'no_decision'

Rating to record for this attribute. One of definitely_not, no, yes, strong_yes, mixed, or no_decision. Omit to leave the attribute unrated (e.g. when only a note is being captured).

job_candidate_attribute_idinteger required

Id of the job's job_candidate_attribute (from /v3/job_candidate_attributes) being rated. Must be a focus attribute on the scorecard's interview kit.

notestring

Optional free-text note explaining the rating.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
scorecard_idinteger

Id of the scorecard this attribute rating belongs to. One row per (scorecard, attribute) pair — the interviewer rated this candidate on this attribute on this scorecard.

candidate_attribute_ratingstring

Interviewer's rating for the attribute on this scorecard. One of definitely_not, no, yes, strong_yes, mixed, or no_decision. no_decision is recorded when the row exists (e.g. a note was left) but no rating was selected.

job_candidate_attribute_idinteger

Id of the job's job_candidate_attribute being rated (the per-job attribute catalogue entry on /v3/job_candidate_attributes). The attribute's display name and candidate_attribute_type live on that record.

notestring nullable

Free-text note the interviewer left for this attribute (e.g. a brief justification for the rating). null when no note was provided.

valuestring

Read-only alias of candidate_attribute_rating, in the same vocabulary the nested write path accepts (candidate_attributes[].value on POST/PATCH /v3/scorecards). A rating cleared with value: null reads back as no_decision.

Changes

No recorded changes to this operation across all 1 revision of this API.