Sign in

v1

latestOpenAPI 3.1.02026-07-24300110.4 KB

PATCH Questionnaire Question

Toggle whether a questionnaire question's answer is reusable by ConveyorAI for future questionnaires, assign the question to a user or collaboration group, or remove the current assignment.

patch/v2/questionnaires/questions/{id}

Path parameters

idstring uuid required

UUID of the question.

Request body

reusableboolean required

Whether this answer should be reused by ConveyorAI.

assignee_emailstring email

Email of the user to assign this question to. Must be a user in your organization. Mutually exclusive with collaboration_group_id and unassign.

collaboration_group_idstring uuid

UUID of the collaboration group (team) to assign this question to. Mutually exclusive with assignee_email and unassign.

unassignboolean

Set to true to remove the current assignee. Mutually exclusive with assignee_email and collaboration_group_id.

Response

Updated questionnaire question.

idstring uuid

Question identifier.

question_type'free_response' | 'multiple_choice'

Question type.

question_textstring

Question text.

bot_answer_textstring nullable

ConveyorAI's draft free-response answer.

bot_structured_answerstring nullable

ConveyorAI's structured answer.

final_answer_textstring nullable

Human-reviewed final free-response answer.

final_structured_answerstring nullable

Human-reviewed final structured answer.

final_structured_answersobject nullable

Human-reviewed final structured answers.

status'ready' | 'accepted' | 'open' | 'not_applicable'

Question status.

questionnaire_idstring uuid

Questionnaire identifier.

questionnaire_type'Security Questionnaire' | 'RFP' | 'Past Answers Import' nullable

Questionnaire type.

connection_domainstring nullable

Connection domain.

reusableboolean

Whether this question's answer is eligible for reuse by ConveyorAI.

created_atstring date-time

When the question was created.

questionnaire_completed_atstring date-time nullable

When the questionnaire was completed.