interviews

Update Question

patch/v1/interviews/{interview_id}/questions/{question_id}

Path parameters

interview_idstring uuid required
question_idstring uuid required

Headers

X-API-Keystring nullable

Request body

question_textstring nullable

Response

Successful Response

idstring uuid required
question_set_idstring uuid required
question_textstring required
is_requiredboolean required
sort_orderinteger required
question_type'open_ended' | 'single_choice' | 'multiple_choice' | 'likert_scale' | 'ranking' | 'statement' | 'range_slider' | 'matrix' required

Shape of an interview question — drives how the agent delivers and how answers get quantified.

optionsstring[] required
component_configobject nullable
follow_up_rule'auto' | 'none' | 'on_short_answers' | 'one_followup' | 'up_to_three' | 'no_followup_allowed' required

Per-question follow-up budget — controls how aggressively the agent probes.

follow_up_guidelinestring
requires_screen_shareboolean
screen_share_promptstring
created_atstring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.