Sign in

v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
PublicQuestionnaires

Submit a questionnaire response via public token (no authentication required)

post/public/questionnaires/submit

Request body

tokenstring required
responsesstring required
submittedBystring nullable

Response

OK

idstring
questionnaireIdstring
patientIdstring nullable
clientIdstring nullable
appointmentIdstring nullable
responsesstring
statusinteger
submittedAtstring date-time nullable
submittedBystring nullable
createdAtstring date-time
updatedAtstring date-time
customAttributesstring nullable
linkExpiresAtstring date-time nullable

Latest expiry among the response's public links. Lets read surfaces derive "Sent, awaiting" (InProgress, unexpired) vs "Expired" (InProgress, expired).

linkFirstViewedAtstring date-time nullable

Earliest first-view among the response's public links (null = never opened). Lets read surfaces distinguish "Sent, awaiting" from "Opened, awaiting".

Example response

{
  "patient": {
    "species": "Cat",
    "breed": "Siamese",
    "sex": "Male"
  }
}