Create scorecard question

Add a question or an instruction line to an interview kit. The response has the same shape as an item from GET /v3/scorecard_questions. The user must be a Site Admin, or a Job Admin who can edit interview plans on the kit's job. Other users get a 403. To add an instruction line, set answer_type to instruction. An instruction line is display-only text with no answer, no answer options and no linked candidate attributes. An instruction line can't be required. Sending required as true with an instruction line returns a 422. Instruction lines are not Interview Prep, which is the exercises field on the interview kit. A multiple-choice question has answer_type single_select or multi_select. Send its answer options in scorecard_question_options. A multiple-choice question needs at least one answer option. Sending one without scorecard_question_options returns a 422. Options are saved in the order you send them. Other answer types can't have answer options. Sending scorecard_question_options with any other answer type returns a 422. The response doesn't include the answer options. To read them, call GET /v3/scorecard_question_options with scorecard_question_ids set to the new question's id. Questions and instruction lines share one order within a kit. sort_order is the item's position among the kit's active items, starting at 0. Leave it out to add the item last. Set it to put the item at that position. Items at or after that position move one place later. A value past the end puts the item last. Every change renumbers the kit's active items 0, 1, 2, and so on. Adding or moving one item changes the sort_order of other items, so read the kit again after a change instead of reusing saved values. Items removed from the kit (active is false) keep their old sort_order. GET /v3/scorecard_questions returns the newest items first, not kit order. To read a kit in order, call it with active=true and sort the results by sort_order. answer_type cannot change after the item is created. If a bulk action is changing the kit's job, the request returns a 409. Retry after the bulk action finishes. Example question request: {"interview_kit_id": 1, "question": "Tell us about a hard bug you fixed.", "answer_type": "text", "required": true}. Example instruction line request: {"interview_kit_id": 1, "question": "Ask follow-up questions about their last project.", "answer_type": "instruction", "sort_order": 0}. Its response: {"id": 2, "interview_kit_id": 1, "question": "Ask follow-up questions about their last project.", "active": true, "answer_type": "instruction", "required": false, "created_at": "2024-01-01T00:00:00.000Z", "updated_at": "2024-01-01T00:00:00.000Z", "sort_order": 0}. Example multiple-choice request: {"interview_kit_id": 1, "question": "Would you hire this candidate?", "answer_type": "single_select", "scorecard_question_options": [{"name": "Yes"}, {"name": "No"}]}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Id of the interview kit to add the item to. Look up a job's kits with GET /v3/interview_kits.

string
required
length ≥ 1
\S

Text of the question, or the body of an instruction line. Basic HTML formatting is allowed. The text is stored exactly as sent.

string
enum
required

How the interviewer answers. text is free-form text. yes_no is a yes or no choice. single_select and multi_select pick from the question's options. instruction is an instruction line: display-only text with no answer. This value cannot change after creation.

Allowed:
boolean
Defaults to false

Whether interviewers must answer the question before they submit the scorecard. Defaults to false. An instruction line can't be required: true with answer_type instruction returns a 422.

integer
≥ 0

Position of the item among the kit's active items, starting at 0. Questions and instruction lines share one order within a kit. Leave it out to put the item last. When set, the item takes that position, and items at or after it move one place later. A value past the end puts the item last. Every change renumbers the kit's active items 0, 1, 2, and so on, so read the kit again after a change instead of reusing saved values.

scorecard_question_options
array of objects
length between 1 and 500

Answer options for a single_select or multi_select question, in display order. Required for those answer types. Not allowed for other answer types.

scorecard_question_options
Responses

401

Unauthorized

Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json