Skip to content

Submit a form

Request

Mark a form as complete. Every required form element must have an answer; otherwise the request is rejected with a 422 listing the missing fields. Once submitted, the form is considered finalized. If all forms in the packet are complete, the packet is also marked complete.

Security
PartnerApiKey and PartnerOAuth
Path
formPacketIdinteger, (int64)required

Form packet ID

formIdinteger, (int64)required

Form ID

formPacketIdinteger, (int64)required
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
includeAnswersboolean

Include form answers in response

Default:true
Example:includeAnswers=true
curl -i -X PUT \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}/form/{formId}/submit?includeAnswers=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Form submitted successfully

Bodyapplication/json
answersArray of objects(FormAnswerDTO)

Form answers (included when includeAnswers=true)

formTemplateIdinteger, (int64)

Form template ID

Example:999
formTemplateNamestring

Form template name

Example:"Patient Intake Form"
idinteger, (int64)

Unique form identifier

Example:54321
isCompleteboolean

Whether this form is complete

Example:true
statusstring

Form status

Enum:"IN_PROGRESS""COMPLETED"
Example:"COMPLETED"
Response
{
  "answers": [
    { … }
  ],
  "formTemplateId": 999,
  "formTemplateName": "Patient Intake Form",
  "id": 54321,
  "isComplete": true,
  "status": "COMPLETED"
}