> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onboardme.app/llms.txt
> Use this file to discover all available pages before exploring further.

# The eForm

> An eForm is a sent form instance created from a template. Use formKey and accessUrl to track and deliver it.

An **eForm** is one send of a template to a stored client or an ad-hoc recipient. Create it with `POST /api/v1/eforms/send`. Sending requires write access and enough subscription or wallet balance.

Set `mute: true` to skip email and deliver `accessUrl` yourself.

See [Send an eForm](/guides/send-eform).

## Attributes

<ResponseField name="formKey" type="uuid">
  Identifier for this sent form instance.
</ResponseField>

<ResponseField name="templateId" type="integer">
  Template id from `GET /api/v1/eforms/templates` (returned there as `formTemplateId`).
</ResponseField>

<ResponseField name="entityKey" type="uuid">
  Present when the form was sent to a stored client. Omitted for ad-hoc recipients.
</ResponseField>

<ResponseField name="accessUrl" type="string">
  Client-facing URL for completing the form.
</ResponseField>

<ResponseField name="emailSent" type="boolean">
  Whether OnboardMe queued an email for this send.
</ResponseField>

<ResponseField name="sent" type="boolean">
  `false` means email failed and the form was left as a draft. You still receive `formKey`.
</ResponseField>

Subscribe to `eform.submitted` with [webhooks](/guides/webhooks).

<RequestExample>
  ```json The eForm object theme={null}
  {
    "formKey": "9a0b1c2d-3e4f-5061-7283-94a5b6c7d8e9",
    "templateId": 42,
    "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
    "accessUrl": "https://anz.onboardme.app/form/9a0b1c2d",
    "emailSent": true,
    "sent": true
  }
  ```
</RequestExample>