Skip to main content
POST
/
v1
/
notes
/
{voiceNoteId}
/
survey
Voice note survey
curl --request POST \
  --url https://app.enzo.health/api/v1/notes/{voiceNoteId}/survey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateType": "oasis"
}
'
{
  "questions": [
    {
      "id": "<string>",
      "instructions": "<string>",
      "order": 123,
      "answerType": "singleChoice",
      "options": [
        {
          "value": "<string>",
          "id": "<string>"
        }
      ],
      "triggerOptionIds": [
        "<string>"
      ],
      "followUpQuestions": [
        {
          "id": "<string>",
          "instructions": "<string>",
          "order": 123,
          "answerType": "singleChoice",
          "options": [
            {
              "value": "<string>",
              "id": "<string>"
            }
          ],
          "triggerOptionIds": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "answers": [
    {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "surveyId": "<string>",
      "questionId": "<string>",
      "answerType": "singleChoice",
      "value": "<unknown>"
    }
  ],
  "unansweredQuestionId": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
voiceNoteId
string
required

Body

application/json
​
templateType
enum<string>
default:oasis
Available options:
oasis,
soap,
narrative,
custom

Response

Successful response

​
questions
object[]
required
​
answers
object[]
required
​
unansweredQuestionId
string