Skip to main content

Form

A Form is a definition of intake questions, the thing a Patient actually fills out. A Form is made up of ordered questions (text, choice, date, signature, matrix, and other question types), and belongs to one Team.

Read-only via API

Forms are authored and edited in the Zentake dashboard, not through the public API. The API exposes list and retrieve only. There is no create/update/delete endpoint for forms.

Key fields

FieldNotes
idRead-only
nameInternal name, used in the dashboard
textPatient-facing name, shown when the form is sent
enabledWhether the form can currently be sent
created_at, updated_atRead-only
questionsOrdered array of questions on the form

Each entry in questions has: id, question_type (an object with question_type / question_subtype, e.g. text, choice, signature, matrix), text, help_text, and order.

Lifecycle

  1. A team builds a Form in the Zentake dashboard, adding pages, questions, required fields, required signatures, and conditional logic.
  2. The Form is enabled when it's ready to send, either directly or as part of a Packet.
  3. Sending it (via a Message) and having a patient complete it produces a Response, one Response per Form submission.
  4. A Form can be reused indefinitely; each submission is its own Response.

See in API Reference