Update scorecard question

Edit a question or an instruction line on an interview kit. An instruction line is a scorecard question with answer_type set to instruction. An item is a question or an instruction line. You can change the question text, the required flag and sort_order. Leave out a field to leave it unchanged. Leave out sort_order to keep the item's place in the order. 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. sort_order is the item's position among the kit's active items, starting at 0. Questions and instruction lines share one order within a kit. Set sort_order to move the item to that position. The items in between shift one place to make room. A value past the end puts the item last. Every change renumbers the kit's active items 0, 1, 2, and so on. Read the kit again after a change instead of reusing saved sort_order values. GET /v3/scorecard_questions returns the newest items first and includes removed items. To read a kit in order, call it with active=true and sort the results by sort_order. answer_type can't change after the item is created. Sending a different answer_type returns a 422. Sending the current answer_type changes nothing. An instruction line can't be required. Sending required as true for an instruction line returns a 422. Sending required as true for a single_select or multi_select question with no answer options returns a 422. Question text with no visible text, such as <p></p>, returns a 422. An item removed from the kit (active is false) can't be edited, and the request returns a 404. Edits also show on scorecards that were already submitted. Those scorecards show the new wording and follow the kit's new order. This endpoint does not change answer options or linked candidate attributes. If a bulk action is changing the kit's job, the request returns a 409. Retry after the bulk action finishes. Example request: {"question": "Tell us about a hard bug you fixed.", "required": true, "sort_order": 0}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
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. Markup with no visible text, such as <p></p>, returns a 422.

string
enum

How the interviewer answers. This value can't change after creation. A different value returns a 422. The current value is accepted and changes nothing.

Allowed:
boolean

Whether interviewers must answer the question before they submit the scorecard. An instruction line can't be required. On an instruction line, true returns a 422 and false changes nothing. A single_select or multi_select question needs at least one answer option before it can be required.

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 keep the item where it is. When set, the item moves to that position, and the items in between shift one place. 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.

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