Add an answer option to a single_select or multi_select question on an interview kit. The response has the same shape as an item from GET /v3/scorecard_question_options. scorecard_question_options are the answer options set up on a question. scorecard_question_answer_options record which option an interviewer picked on a scorecard. This endpoint creates scorecard_question_options. 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. A question with any other answer_type returns a 422. That includes instruction lines (answer_type is instruction), which are display-only. An unknown scorecard_question_id, or one for a question removed from its kit, also returns a 422. name is the label interviewers see. Spaces and line breaks at the start and end of name are removed. The request returns a 422 if name is empty or has a line break inside it. An active option is one that has not been removed (active is true). The request also returns a 422 if name matches the name of an active option on the question. The match is case-sensitive, so Yes and yes can both exist on one question. A name that matches a removed option creates a new option with a new id. A question can have up to 500 active options. Adding one more returns a 422. sort_order is the option's position among the question's active options, starting at 0. Leave it out to add the option last. Set it to put the option at that position. Options at or after that position move one place later. A value past the end puts the option last. Every change renumbers the question's active options 0, 1, 2, and so on. Adding an option can change the sort_order of the question's other options. After each add, read the options again instead of reusing saved sort_order values. Options on other questions keep their sort_order. Removed options (active is false) keep their old sort_order. GET /v3/scorecard_question_options returns the newest options first, not in sort_order. It also returns removed options. To read a question's options in order, call it with scorecard_question_ids and active=true. Set per_page=500, or read every page, then sort the results by sort_order. If a bulk action is changing the kit's job, the request returns a 409. Retry after the bulk action finishes. Example request: {"scorecard_question_id": 10, "name": "Strong yes", "sort_order": 0}. Its response: {"id": 25, "scorecard_question_id": 10, "name": "Strong yes", "active": true, "created_at": "2024-01-01T00:00:00.000Z", "updated_at": "2024-01-01T00:00:00.000Z", "sort_order": 0}.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Unauthorized