Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Scorecard Question Answers

Update scorecard question answer

Update an existing scorecard question answer in place. Only the response fields (answer for text questions, boolean_value for yes_no questions) can be changed; the scorecard_id / scorecard_question_id linkage is immutable and sending either is rejected as a disallowed property. Sending the wrong field for the question's answer_type returns a 422.

patch/v3/scorecard_question_answers/{id}

Path parameters

idinteger required

Request body

answerstring nullable

Updated free-text response for text-type questions. Send null or an empty string to clear the answer. Rejected with a 422 if the underlying question's answer_type is not text.

boolean_valueboolean nullable

Updated response for yes_no-type questions: true for yes, false for no, null to clear. Rejected with a 422 (Cannot update boolean value for non-boolean question.) if the underlying question's answer_type is not yes_no.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
scorecard_idinteger

Id of the scorecard this answer belongs to. Every answer is tied to exactly one scorecard, which in turn belongs to a single interviewer's submission on one application.

scorecard_question_idinteger

Id of the scorecard_question this answer responds to. The question's answer_type (text, yes_no, single_select, multi_select) determines which field on the answer is populated: text uses answer, yes_no uses boolean_value, and single_select/multi_select use the scorecard_question_answer_options sub-resource.

answerstring nullable

Free-text response for text-type scorecard questions. Plain text — HTML formatting and @-mention markup are stripped. null (or empty string) when the question is yes_no, single_select, or multi_select, or when the interviewer declined to answer.

answer_with_tagsstring nullable

HTML-formatted version of answer, preserving rich-text formatting (bold, italic, etc.) and @-mentions as embedded user tags (e.g. @[User Name](user:123)). null when there is no formatting or markup to preserve (i.e. when the stored value would be identical to answer), and under the same conditions as answer.

boolean_valueboolean nullable

Response for yes_no-type scorecard questions: true for yes, false for no, null when the question is not yes_no or when the interviewer left it blank. Ignored on writes for any question whose answer_type is not yes_no.