Skip to main content
PATCH
Update Question

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

interview_id
string<uuid>
required
question_id
string<uuid>
required

Body

application/json
question_text
string | null

Response

Successful Response

id
string<uuid>
required
question_set_id
string<uuid>
required
question_text
string
required
is_required
boolean
required
sort_order
integer
required
question_type
enum<string>
required

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

Available options:
open_ended,
single_choice,
multiple_choice,
likert_scale,
ranking,
statement,
range_slider,
matrix
options
string[]
required
follow_up_rule
enum<string>
required

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

Available options:
auto,
none,
on_short_answers,
one_followup,
up_to_three,
no_followup_allowed
created_at
string<date-time>
required
component_config
Component Config · object | null
follow_up_guideline
string
default:""
requires_screen_share
boolean
default:false
screen_share_prompt
string
default:""