ONontora
interviews

Update Question Set

Changed on
patch/v1/interviews/{interview_id}/question-sets/{set_id}

Request

Path parameters

interview_idstring uuid required
set_idstring uuid required

Headers

X-API-Keystring nullable

Request body

namestring nullable
descriptionstring nullable

Response

Successful Response

idstring uuid required
interview_idstring uuid required
namestring required
descriptionstring nullable required
sort_orderinteger required
section_typestring nullable
topic_metadataobject nullable

Topic steering. priority: required, important or optional. success_criteria: one to three strings, when the topic counts as understood. success_threshold: the legacy single criterion, read only when success_criteria is absent. mentions: what the interviewer brings up on its own in this topic. sub_topics: list of strings.

created_atstring date-time required

Changes