Sign in

v1

latestOpenAPI 3.1.02026-07-24300110.4 KB

POST Questionnaire Question Answer

Write or update an answer on a questionnaire question. Creates a new immutable answer revision; the previous answer is preserved in edit_history. Requires api_questionnaires with write capability, the same permission as PATCH Questionnaire Question. At least one answer field must be provided. Errors: 400 when no answer fields are provided or the question is not found; 403 when the API key lacks api_questionnaires write permission.

post/v2/questionnaires/questions/{id}/answer

Path parameters

idstring required

Question ID.

Request body

prosestring

Long-form answer text.

structured_answerstring

Short answer, for example Yes or No.

structured_answersstring[]

Multi-select answers.

object_responseobject

Column-based answers for object_response questions.

Response

Returns the full question object with updated final_answer_text, final_structured_answer, final_structured_answers, final_object_response, edit_history, and last_edited_by.

idstring uuid

Unique identifier for the question.

question_type'free_response' | 'select_one' | 'select_multiple' | 'object_response'

The answer format expected for this question.

question_textstring

The question.

bot_answer_textstring nullable

ConveyorAI's draft free-response answer, or null if no answer was generated.

bot_structured_answerstring nullable

ConveyorAI's draft answer for select_one questions, or null.

bot_object_responseobject nullable

ConveyorAI's draft answer for object_response type questions. An object mapping column label to answer value. Null for other question types.

final_answer_textstring nullable

Updated human-reviewed final free-response answer, or null if not provided.

final_structured_answerstring nullable

Updated human-reviewed final answer for select_one questions, or null if not provided.

final_structured_answersstring[] nullable

Updated human-reviewed final answers for select_multiple questions, or null if not provided.

final_object_responseobject nullable

Updated human-reviewed answer for object_response type questions. Null for other question types or if not provided.

statusstring

The review status of the question.

reusableboolean

Whether this question's answer is eligible for the Past Answers Knowledge Base.

questionnaire_idstring uuid nullable

ID of the parent questionnaire, if applicable.

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

Cleaned label for the parent questionnaire type.

connection_domainstring nullable

Domain of the customer who sent this questionnaire.

created_atstring date-time

When the question was created.

questionnaire_completed_atstring date-time nullable

When the parent questionnaire was marked completed.