v2

latestOpenAPI 3.1.12026-08-078549932.4 MB

QuestionnaireResponses

Update an existing questionnaire response

put/QuestionnaireResponses/{id}

Path parameters

idstring required

Request body

responsesstring nullable

statusinteger

customAttributesstring nullable

Response

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"
  }
}