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

# WhatsApp forms

> Create native WhatsApp forms in Chatarmin and open them from template buttons in campaigns and flows.

**WhatsApp forms** are multi-screen questionnaires that customers complete inside WhatsApp. You build them in Chatarmin, publish them to your WhatsApp Business account, and open them with an **Open form** button on a [message template](/features-in-depth/templates/templates-explained).

<Note>
  WhatsApp forms are not the same as [Chatarmin Flows](/features-in-depth/flows/flows-explained). Flows automate conversations in Chatarmin; WhatsApp forms are Meta-native forms opened from a template button.
</Note>

## When to use it

Use WhatsApp forms when you want structured answers without leaving WhatsApp—for example surveys, lead capture, sign-ups, appointment requests, or support intake.

## Set it up

<Steps>
  <Step title="Open WhatsApp forms">
    In the dashboard, go to **Templates** → **WhatsApp forms**, or open [WhatsApp forms](https://chatarmin.com/dashboard/whatsapp-forms).
  </Step>

  <Step title="Create a form">
    Click **New form**, enter a name (each form needs a unique name on your WhatsApp account), and click **Create**.
  </Step>

  <Step title="Build screens">
    Add one or more **screens**. For each screen, set a **screen name**, add content blocks, and set the footer **button** label (for example **Continue**).

    You can add:

    * **Text** — heading, subheading, paragraph, small note
    * **Media** — image (PNG or JPEG, up to 5 MB) or embedded link
    * **Text answer** — short answer, long answer, or date
    * **Selection** — dropdown, single choice, multiple choice, or consent (opt-in)

    Drag screens and fields to reorder them. Answer fields need a **label**, an **answer name** (lowercase, no spaces, unique across the whole form), and you can mark whether the customer must answer.
  </Step>

  <Step title="Save and publish">
    Click **Save**. Fix any validation messages shown at the top of the editor. When the form is valid, click **Publish** so customers can open it.

    Use **WhatsApp preview** (after save) to see the form as customers see it on WhatsApp.
  </Step>

  <Step title="Add the form to a template">
    When [creating or editing a template](/features-in-depth/templates/templates-explained), add a button and choose **Open form**. Set the **button text** (up to 25 characters) and select a **published** form from the list.

    Submit the template for Meta approval as usual. The form must stay **Published** for the button to work.
  </Step>

  <Step title="Send the template (optional prefill and contact fields)">
    When you send that template in a [campaign](/features-in-depth/campaigns) or as a **Send template** step in a [flow](/features-in-depth/flows/flows-explained), you can:

    * **Prefill the form** — fill fields with fixed text or values from contact fields (first screen only)
    * **Save answers to the contact** — map each form answer to a contact field, or leave a field unmapped if you only use the answer for branching

    Leave a mapping empty if the answer should only drive the next step in the flow and not update the contact profile.
  </Step>
</Steps>

## Manage forms on the list page

Each row shows **Sent**, **Submitted**, **Completed** (completion rate when sent > 0), **Screens**, and last updated time.

Use the **⋯** menu on a form:

| Action | What it does |
| - | - |
| **WhatsApp preview** | Opens Meta’s preview (when available) |
| **Publish** | Available for **Draft** forms |
| **Deprecate** | Stops customers from opening a **Published** form (cannot be undone) |
| **Duplicate** | Copy to the same Chatarmin account or another account you have access to |
| **Export answers (CSV)** | Download submission data |
| **Delete** | Removes the form from Chatarmin; deleting a published form also deprecates it on WhatsApp |

Filter with **Search forms** and **All Status** (Draft, Published, Deprecated).

## Categories

Each form has a **category** (Survey, Contact us, Customer support, Appointment, Lead, Sign up, Sign in, Other). Meta uses this for labeling only—it does not change how the form looks or behaves.

## After publish

* **Draft** forms are fully editable. **Published** and **Deprecated** forms are read-only in the builder.
* To change a published form, **Duplicate** it, edit the copy, and publish the new version. Deprecate the old form if you no longer need it.
* You can rename a published form in Chatarmin; that does not change the name on WhatsApp.

## Best practices

* Give every answer field a clear **label** and a unique **answer name** before you publish.
* Test with **WhatsApp preview** before linking the form in a live template.
* Export answers periodically if you need offline reporting.
* Deprecate old forms instead of deleting them while a template still references them—update the template to a new published form first.

## Troubleshooting

**Save or Publish shows errors**\
Read the red messages at the top of the editor. Common fixes: fill required fields, fix duplicate answer names, or upload a valid image (PNG/JPEG, max 5 MB).

**Publish is disabled**\
Save first and clear all validation errors.

**No forms in the template dropdown**\
Only **Published** forms appear. Publish the form before editing the template.

**Customers cannot open the form**\
Confirm the form is **Published**, the template is approved, and the form was not **Deprecated** or deleted.

**I need to edit a live form**\
Duplicate the form, publish the duplicate, update your template button to the new form, then deprecate the old one.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.