Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Scorecard Question Answers

Create scorecard question answer

Create one interviewer response to one scorecard question. Use this to attach a text answer (via answer) or a yes_no answer (via boolean_value) to an existing scorecard; for single_select / multi_select questions, create the row here with answer and boolean_value left blank, then add option selections through the scorecard_question_answer_options endpoint.

post/v3/scorecard_question_answers

Request body

scorecard_idinteger required

Id of the scorecard to attach this answer to. The scorecard must belong to your organization and the requesting user must have permission to edit it.

scorecard_question_idinteger required

Id of the scorecard_question being answered. Must reference a question on the same interview_kit as the target scorecard; the question's answer_type determines which of answer or boolean_value is meaningful (single_select / multi_select answers are created via the scorecard_question_answer_options endpoint).

answerstring nullable

Free-text response for text-type questions. Send null or an empty string to record "no answer". Ignored for yes_no, single_select, and multi_select questions.

boolean_valueboolean nullable

Response for yes_no-type questions: true for yes, false for no, null to leave blank. Rejected with a 422 if the referenced 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.