Creates a new Questionnaire Submittal. Upon submission, the API will validate that all required questions (and follow-up questions) have been appropriately answered.

📘
Note for questions with multiple answers
When submitting questions that have more than one answer, include a questionnaireAnswers object for each answer. The questionId will be the same, however the response will be unique for each answer.

Endpoint

POST /qna/v1/questionnaire/submittal

Parameters

questionnaireId string: required The unique identifier of the questionnaire you are creating the submittal for.

questionnaireId string: required The unique identifier of the user that the submittal belongs to.

questionAnswers list of objects: required A list of questions and corresponding answers.

questionId string: required

The questionId of the question being answered.

responseValue string: required

The value that should be saved as the response. For questions with a questionType of strict, this value will be the response value found in the Question Response object. For questions with a questionType of open, this value will be set to the free-form value provided by the user.

Example

{
	"questionnaireId": "quesna_d948a513327c4185b9ec683dc1bf83c6",
	"userId": "mem_5b9f2b8397fc4f3db245a2aa5a775945",
	"questionnaireAnswers": [
		{
			"questionId": "quesqu_afed4982e8134edfbd5ee85f12c3246c",
			"responseValue": "Never"
		},
		{
			"questionId": "quesqu_29bb999a313d4a0cb5c87f6c1aaa5d9f",
			"responseValue": "Yes"
		}
	]
}

Response

A Questionnaire Submittal Object.