# Create a form from a definition or a preset

HTML: https://www.app2email.com/docs/api/submit-info/create-form · Index: https://www.app2email.com/docs/api/llms.txt

`POST https://api.app2email.com/v1/{number}/submit/forms`

Scope: `submissions:manage`. Not with a sandbox key. Send `name` and `definition` (the SubmitFormDefinition schema explains every key; a minimal form is a title and one step with one field). `name` alone makes a starter form with one question to change. `preset` installs a ready-made solution instead: its form with the lists and automations that belong to it (`applied` in the answer names them). The definition is checked as a whole: 400 `invalid_form` lists every problem with its path (`definition.steps[0].fields[1].label`) and a fix, and nothing is saved. The answer is the form with its normalized definition and its links. The web page works at once; to open the form inside WhatsApp call POST /submit/forms/{key}/publish next. A number has at most 100 forms.

|  |  |
| --- | --- |
| Scope | `submissions:manage` |
| Sandbox key | refused (https://www.app2email.com/docs/api/sandbox.md) |
| MCP tool | `create_form` on https://api.app2email.com/mcp |

## Parameters

| Name | In | Type | Required | Notes |
| --- | --- | --- | --- | --- |
| `number` | path | string | yes | Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.; eg `4976659348270` |

## Body

`application/json`, required

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `key` | string |  | The form's key: lower case letters, digits and _, starting with a letter, at most 40 characters (check is reserved). Left out: made from the name. It is part of the web address and cannot be changed later. |
| `name` | string |  | The name in the dashboard and the inbox. Needed with definition. |
| `definition` | object |  | A form as one document. The same JSON drives the WhatsApp form (app2email generates it: there is nothing to draw), the web page, the checks on every answer, the inbox columns and the exports. `steps` hold the fields; `stages` are the states a submission moves through; `who`, `trigger`, `after`, `web`, `notify`, `calculated` and `retention_days` are optional and take their defaults when left out. Limits: 12 steps, 12 fields in a step, 60 fields in a form, one location field, 64 KB of JSON. A save is checked as a whole: with any problem nothing is saved and the 400 answer lists each one with its path and a fix. The saved form comes back normalized, with every default filled in. Saving changes the working copy; WhatsApp keeps showing the published version until POST /submit/forms/{key}/publish is called again. Conditions: a step or a field with `show_if` appears only when its rule holds, and the rule may only look at fields of earlier steps. A rule is {"field": "<key>", <operator>: <value>} with the operators equals, not_equals, in, not_in, contains, empty, not_empty, gt, gte, lt, lte. Every operator written in one rule must hold. When the field's value is an array (multiselect, tags) a rule holds when any item matches, except not_equals and not_in, which need every item. Rules combine as {"all": [rule, ...]} (every one) or {"any": [rule, ...]} (at least one); groups nest 2 deep with up to 10 rules each. null = no condition. Examples: {"field": "deliver", "equals": true}; {"all": [{"field": "amount", "gt": 5000}, {"field": "category", "in": ["plant", "vehicle"]}]}. |
| `definition.title` | string | yes | The form's public name, 1 to 60 characters.; 1–60 chars |
| `definition.description` | string |  | Under the title on the web page and in the forms menu, up to 300 characters.; max 300 chars |
| `definition.prefix` | string |  | 2 to 4 letters A-Z that start every reference of this form (MR-7Q3M2A). "" = the settings' default_prefix. |
| `definition.steps` | object[] | yes | 1 to 12 steps, in the order they are asked. One step is one screen; app2email splits a step over several screens by itself when WhatsApp's limits demand it.; 1–12 items |
| `definition.steps.key` | string | yes | The step's name: a lower case letter, then lower case letters, digits or _ (at most 40 characters). Unique among the steps.; pattern ^[a-z][a-z0-9_]{0,39}$ |
| `definition.steps.title` | string | yes | The screen's title, 1 to 60 characters (WhatsApp shows the first 30).; 1–60 chars |
| `definition.steps.text` | string |  | Shown above the fields, up to 500 characters.; max 500 chars |
| `definition.steps.show_if` | object |  | A rule on fields of EARLIER steps: the step is skipped when it does not hold. null = always.; more keys allowed |
| `definition.steps.show_if.field` | string |  | A field key (or an extra key). Automations may also name status, status_kind, channel, form, priority, tags, assignee, verified, files_count, contact.name, contact.phone. |
| `definition.steps.show_if.equals` | any |  |  |
| `definition.steps.show_if.not_equals` | any |  |  |
| `definition.steps.show_if.in` | any[] |  |  |
| `definition.steps.show_if.not_in` | any[] |  |  |
| `definition.steps.show_if.contains` | any |  |  |
| `definition.steps.show_if.empty` | boolean |  |  |
| `definition.steps.show_if.not_empty` | boolean |  |  |
| `definition.steps.show_if.gt` | any |  |  |
| `definition.steps.show_if.gte` | any |  |  |
| `definition.steps.show_if.lt` | any |  |  |
| `definition.steps.show_if.lte` | any |  |  |
| `definition.steps.show_if.all` | object[] |  | A group: every rule in it must hold. |
| `definition.steps.show_if.any` | object[] |  | A group: at least one rule in it must hold. |
| `definition.steps.fields` | object[] | yes | 1 to 12 fields. Internal and hidden fields count but show nothing.; 1–12 items |
| `definition.steps.fields.key` | string | yes | The field's name in answers, rules, placeholders, formulas and exports: a lower case letter, then lower case letters, digits or _ (at most 40 characters). Unique in the form, not a reserved word, not starting with _. Reserved: reference, status, status_name, form, form_key, channel, contact, link, id, created, updated, assignee, priority, tags, due, files, flow_token, screen, error_message, error, answers, extra, submission, note, button, business, desk_link, status_kind, verified, files_count, prefill, confirm, true, false, null, and, or, not.; pattern ^[a-z][a-z0-9_]{0,39}$ |
| `definition.steps.fields.type` | string | yes | The field type decides the answer's JSON type, the keys that apply and how WhatsApp shows it. `text` (value: string; on WhatsApp: text input): min_length, max_length, pattern. `textarea` (value: string; on WhatsApp: text area): min_length, max_length, pattern. `number` (value: number; on WhatsApp: number input): min, max, decimals, unit. `email` (value: string; on WhatsApp: e-mail input). `phone` (value: string; on WhatsApp: phone input). 6 to 20 digits. `date` (value: string, YYYY-MM-DD; on WhatsApp: date picker): min_days, max_days. `select` (value: string: the id of the choice; on WhatsApp: radio buttons up to 8 choices, a dropdown above that): choices, list. While its list is empty a select is not required and not checked. `multiselect` (value: array of strings: the ids of the choices; on WhatsApp: checkboxes): choices, min_choices, max_choices. `yesno` (value: boolean; on WhatsApp: Yes / No radio buttons). `rating` (value: number, 1 to max; on WhatsApp: radio buttons 1 to max): max. `consent` (value: boolean; on WhatsApp: a tick box). The label is the sentence to agree to (at most 120 characters). required true = it must be ticked. `photo` (value: array of file ids; on WhatsApp: photo picker): max_files, source. WhatsApp allows one photo or document picker on a screen: a step with several is split into several screens by itself. `document` (value: array of file ids; on WhatsApp: document picker): max_files, kinds. One picker on a screen, as for photo. `location` (value: string: the address text; the pin is the submission's location {lat, lng, name, address}; on WhatsApp: asked after the form with WhatsApp's own Send location request). On the web page: a Use my location button and an address line. One location field in a form; required is not enforced for it. `info` (value: nothing is stored; on WhatsApp: a heading (the label) and text): text. `hidden` (value: string; on WhatsApp: nothing is shown). The value is the field's default (usually {prefill.<key>}), or the prefill value given under the field's own key: a job number or an account that arrives with the link or the send call.; one of: `text`, `textarea`, `number`, `email`, `phone`, `date`, `select`, `multiselect`, `yesno`, `rating`, `consent`, `photo`, `document`, `location`, `info`, `hidden` |
| `definition.steps.fields.label` | string | yes | The question, 1 to 200 characters. A label longer than WhatsApp allows on the input is moved into text above it by itself.; 1–200 chars |
| `definition.steps.fields.help` | string |  | A hint with the input, up to 80 characters.; max 80 chars |
| `definition.steps.fields.required` | boolean |  | true: must be answered (consent: must be ticked). Default false. Not enforced for a location field: the pin arrives after the form. |
| `definition.steps.fields.internal` | boolean |  | true: never asked. Staff, the API or an automation fill it (a quote amount, a decision reason, an id another system returned). Its value is stored in the submission's extra and shows in the inbox and in exports. Only for the types text, textarea, number, email, phone, date, select, multiselect, yesno and rating; an internal field is never required and has no show_if. Default false. |
| `definition.steps.fields.show_if` | object |  | A rule on fields of EARLIER steps: the field is asked only when the rule holds. The rule may look at fields that are asked or hidden, not at internal or info fields. A field that is not shown counts as empty for the rules after it. null = always.; more keys allowed |
| `definition.steps.fields.show_if.field` | string |  | A field key (or an extra key). Automations may also name status, status_kind, channel, form, priority, tags, assignee, verified, files_count, contact.name, contact.phone. |
| `definition.steps.fields.show_if.equals` | any |  |  |
| `definition.steps.fields.show_if.not_equals` | any |  |  |
| `definition.steps.fields.show_if.in` | any[] |  |  |
| `definition.steps.fields.show_if.not_in` | any[] |  |  |
| `definition.steps.fields.show_if.contains` | any |  |  |
| `definition.steps.fields.show_if.empty` | boolean |  |  |
| `definition.steps.fields.show_if.not_empty` | boolean |  |  |
| `definition.steps.fields.show_if.gt` | any |  |  |
| `definition.steps.fields.show_if.gte` | any |  |  |
| `definition.steps.fields.show_if.lt` | any |  |  |
| `definition.steps.fields.show_if.lte` | any |  |  |
| `definition.steps.fields.show_if.all` | object[] |  | A group: every rule in it must hold. |
| `definition.steps.fields.show_if.any` | object[] |  | A group: at least one rule in it must hold. |
| `definition.steps.fields.default` | string |  | The starting value, up to 500 characters: a literal, or the placeholders {contact.name}, {contact.phone}, {contact.<custom field>}, {prefill.<key>} (prefill = the values given when the form is sent). Not for photo, document, location and info. |
| `definition.steps.fields.sensitive` | boolean |  | true: the value is masked in WhatsApp's own summary of the form. Only for the types text, textarea, number, email, phone, date, select, multiselect, yesno and rating. Default false. |
| `definition.steps.fields.min_length` | integer |  | text, textarea. Fewest characters. 0 = none.; min 0 |
| `definition.steps.fields.max_length` | integer |  | text, textarea. Most characters. 0 = the type's limit (text 200, textarea 2,000).; min 0 |
| `definition.steps.fields.pattern` | string |  | text, textarea. A regular expression the whole answer must match, up to 200 characters.; max 200 chars |
| `definition.steps.fields.min` | number |  | number. Smallest value. null = none. |
| `definition.steps.fields.max` | number |  | number: the largest value, null = none. rating: the highest rating, 3 to 10, default 5. |
| `definition.steps.fields.decimals` | integer |  | number. Decimal places allowed, 0 to 6. Default 0.; 0–6 |
| `definition.steps.fields.unit` | string |  | number. Shown after the value, for example kWh. Up to 20 characters. |
| `definition.steps.fields.min_days` | integer |  | date. Earliest day, counted from today (negative = in the past). null = none. |
| `definition.steps.fields.max_days` | integer |  | date. Latest day, counted from today. null = none. |
| `definition.steps.fields.choices` | object[] |  | select: 2 to 200 choices (or use list). multiselect: 2 to 20 choices. |
| `definition.steps.fields.choices.id` | string | yes | What is stored as the answer. Unique in the field.; max 40 chars |
| `definition.steps.fields.choices.title` | string | yes | What people see (WhatsApp shows the first 30 characters).; max 80 chars |
| `definition.steps.fields.choices.description` | string |  | A second line, optional.; max 300 chars |
| `definition.steps.fields.list` | string |  | select. Instead of choices: the key of a list of the number (GET /submit/lists). The list is read each time the form opens, so changing it needs no publish. At most 200 items are shown. |
| `definition.steps.fields.min_choices` | integer |  | multiselect. Fewest ticks. 0 = none.; min 0 |
| `definition.steps.fields.max_choices` | integer |  | multiselect. Most ticks. 0 = no limit.; min 0 |
| `definition.steps.fields.max_files` | integer |  | photo, document. How many files, 1 to 10.; 1–10 |
| `definition.steps.fields.source` | string |  | photo. Where the photo may come from.; one of: `any`, `camera`, `gallery` |
| `definition.steps.fields.kinds` | string[] |  | document. What may be sent: ["any"] (default), or some of pdf, image, office.; one of: `any`, `pdf`, `image`, `office` |
| `definition.steps.fields.text` | string |  | info. The text shown, up to 1,000 characters.; max 1000 chars |
| `definition.stages` | object[] |  | 2 to 12 stages a submission moves through. The first one is where a new submission starts. At least one of kind open and one of kind done. Left out: New (open), In progress (open), Done (done).; 2–12 items |
| `definition.stages.key` | string | yes | The stage's name in the API (the submission's status): a lower case letter, then lower case letters, digits or _ (at most 40 characters). Unique in the form.; pattern ^[a-z][a-z0-9_]{0,39}$ |
| `definition.stages.name` | string | yes | What people see, for example In review. Up to 40 characters. |
| `definition.stages.kind` | string | yes | open: still being worked on. done: finished well. cancelled: finished without a result. A form needs at least one open and one done stage.; one of: `open`, `done`, `cancelled` |
| `definition.stages.color` | string |  | grey, blue, green, amber, red or purple.; one of: `grey`, `blue`, `green`, `amber`, `red`, `purple` |
| `definition.stages.set_by` | string[] |  | The roles that may choose this stage: some of owner, admin, manager, agent, viewer. [] = anyone who may change stages. Owners, admins, automations and API keys always may.; one of: `owner`, `admin`, `manager`, `agent`, `viewer` |
| `definition.stages.require_note` | boolean |  | true: a note must come with the move to this stage. |
| `definition.stages.message` | string |  | Sent to the submitter when the submission arrives in this stage, up to 1,000 characters, with placeholders ({note} = the note of the change). "" = nothing is sent.; max 1000 chars |
| `definition.who` | object |  | Who may submit. |
| `definition.who.mode` | string |  | listed: only the numbers below, or contacts with the tag, may submit (a form for field staff). listed needs at least one number or a tag.; one of: `anyone`, `listed` |
| `definition.who.numbers` | string[] |  | Up to 500 numbers, digits only with country code (6 to 20 digits). |
| `definition.who.tag` | string |  | A contact tag: contacts carrying it may submit.; max 40 chars |
| `definition.trigger` | object |  | The message that opens the form on WhatsApp, and the words that send it. |
| `definition.trigger.words` | string[] |  | A contact who sends one of these words gets the form. Up to 10 words, 30 characters each. A word that another form of the number or an enabled Book-and-Pay word already uses is refused (word_taken).; max 10 items |
| `definition.trigger.header` | string |  | A bold line above the body, optional.; max 60 chars |
| `definition.trigger.body` | string |  | The text of the message that carries the form, 1 to 1,000 characters. Left out: Tap the button to open the form.; max 1000 chars |
| `definition.trigger.button` | string |  | The button's text, 1 to 20 characters. Left out: Open form.; max 20 chars |
| `definition.trigger.footer` | string |  | A small grey line, optional.; max 60 chars |
| `definition.after` | object |  | What happens right after a submission. |
| `definition.after.review_step` | boolean |  | A last screen that lists the answers before sending. |
| `definition.after.reply` | string |  | The WhatsApp message after sending, with placeholders ({reference}, {form}, {contact.name} ...). "" = no reply. Left out: a thank-you with the reference.; max 1000 chars |
| `definition.after.allow_additions` | boolean |  | The reply gets an Add more button: text, photos and files the submitter sends in the next 10 minutes are attached to the submission. |
| `definition.after.status_page` | boolean |  | The reply carries a button to the submitter's status page. |
| `definition.web` | object |  | The web page of the form. |
| `definition.web.enabled` | boolean |  | The form has a web page (links.web of the form). |
| `definition.web.verify` | string |  | Proving the WhatsApp number of a web submission with one message. optional: offered as Get updates on WhatsApp. required: the submission counts only once proven. off: never asked.; one of: `off`, `optional`, `required` |
| `definition.web.ask_email` | boolean |  | Also ask for an e-mail address at the end. |
| `definition.web.success_text` | string |  | Shown after sending. "" = the standard text.; max 500 chars |
| `definition.notify` | object |  | The e-mail the business gets. |
| `definition.notify.email` | boolean |  | E-mail the business for each submission (to the settings' notify_email). |
| `definition.notify.to` | string[] |  | Up to 5 more addresses.; max 5 items |
| `definition.notify.attach_files` | boolean |  | Attach the submission's files. |
| `definition.calculated` | object[] |  | 0 to 20 calculated fields: values worked out from the answers each time they change, stored in extra. Formulas (calculated fields, the calculate action, and {= ... } inside any text): numbers, 'texts' in single quotes, field keys, + - * / %, the comparisons == != > >= < <=, and / or / not, brackets, and the functions if(condition, then, else): then when the condition holds, otherwise else (null without an else). min(a, b, ...): The smallest number. max(a, b, ...): The largest number. round(x, decimals): x rounded, half away from zero; decimals 0 to 10, default 0. abs(x): x without its sign. num(x): x as a number, null when it is not one. len(x): The length of a text, or the number of items of a list. coalesce(a, b, ...): The first value that is not empty. lower(x): x in lower case. upper(x): x in upper case. concat(a, b, ...): The values joined as one text. lookup('<list>', id, '<column>'): A column of the item with that id in a list of the number, for example a price. previous('<field>'): The same contact's last value of that field in this form. count_files('<field>'): How many files a photo or document field holds. days_since(date): Whole days from a date (YYYY-MM-DD) to today; negative for a date to come. No loops and no assignment; at most 500 characters; a division by zero or a missing number gives null. Examples: reading - previous('reading'); quantity * lookup('products', product, 'price'); if(usage < 0, 'check', 'ok'); round(amount * 1.2, 2); days_since(purchase_date) > 30 and count_files('receipt') == 0.; max 20 items |
| `definition.calculated.key` | string | yes | Its name in extra, rules and placeholders. Same rules as a field key. |
| `definition.calculated.label` | string |  | max 60 chars |
| `definition.calculated.formula` | string | yes | max 500 chars |
| `definition.calculated.unit` | string |  |  |
| `definition.calculated.decimals` | integer |  | 0–6 |
| `definition.retention_days` | integer |  | 0 = keep. Otherwise closed submissions and their files are erased this many days after closing (30 to 3650). |
| `preset` | string |  | Instead of a definition: install this preset (GET /submit/presets): its form together with the lists and automations that belong to it. key and name, when given, rename its form. |

### Example

```json
{
  "key": "meter_reading",
  "name": "Meter reading",
  "definition": {
    "title": "Meter reading",
    "description": "Send us this month's reading.",
    "prefix": "MR",
    "steps": [
      {
        "key": "reading",
        "title": "Your reading",
        "text": "",
        "show_if": null,
        "fields": [
          {
            "key": "meter_no",
            "type": "text",
            "label": "Meter number",
            "help": "On the front of the meter",
            "required": true,
            "default": "{contact.meter_no}",
            "max_length": 20
          },
          {
            "key": "reading",
            "type": "number",
            "label": "Meter reading",
            "required": true,
            "min": 0,
            "max": 999999,
            "decimals": 0,
            "unit": "kWh"
          },
          {
            "key": "photo",
            "type": "photo",
            "label": "Photo of the meter",
            "required": true,
            "max_files": 1,
            "source": "camera"
          },
          {
            "key": "moving",
            "type": "yesno",
            "label": "Are you moving out?",
            "required": true
          },
          {
            "key": "billing_ref",
            "type": "text",
            "label": "Billing reference",
            "internal": true
          }
        ]
      },
      {
        "key": "move",
        "title": "Your move",
        "text": "We will close the account on that day.",
        "show_if": {
          "field": "moving",
          "equals": true
        },
        "fields": [
          {
            "key": "move_date",
            "type": "date",
            "label": "Moving date",
            "required": true,
            "min_days": -30,
            "max_days": 90
          },
          {
            "key": "new_address",
            "type": "textarea",
            "label": "New address for the final bill",
            "required": false,
            "max_length": 300
          }
        ]
      }
    ],
    "stages": [
      {
        "key": "received",
        "name": "Received",
        "kind": "open",
        "color": "blue",
        "set_by": [],
        "require_note": false,
        "message": ""
      },
      {
        "key": "queried",
        "name": "Queried",
        "kind": "open",
        "color": "amber",
        "set_by": [],
        "require_note": true,
        "message": "We have a question about your reading {reference}: {note}"
      },
      {
        "key": "checked",
        "name": "Checked",
        "kind": "done",
        "color": "green",
        "set_by": [
          "manager"
        ],
        "require_note": false,
        "message": "Thanks {contact.name}, your reading of {reading} kWh is recorded."
      }
    ],
    "who": {
      "mode": "anyone",
      "numbers": [],
      "tag": ""
    },
    "trigger": {
      "words": [
        "meter",
        "reading"
      ],
      "header": "",
      "body": "Tap the button to send your reading.",
      "button": "Open form",
      "footer": ""
    },
    "after": {
      "review_step": true,
      "reply": "Thanks {contact.name}. We have your {form} - reference {reference}.",
      "allow_additions": false,
      "status_page": true
    },
    "web": {
      "enabled": true,
      "verify": "optional",
      "ask_email": false,
      "success_text": ""
    },
    "notify": {
      "email": true,
      "to": [],
      "attach_files": true
    },
    "calculated": [
      {
        "key": "usage",
        "label": "Usage",
        "formula": "reading - previous('reading')",
        "unit": "kWh",
        "decimals": 0
      }
    ],
    "retention_days": 0
  }
}
```

## Responses

| Status | Meaning | error.code |
| --- | --- | --- |
| 201 | Made. |  |
| 400 | The request is malformed (missing or invalid fields, query parameters or times). | `invalid_number_in_url`, `invalid_json`, `unsupported_message_type`, `invalid_to`, `too_many_recipients`, `missing_template_name`, `missing_template_language`, `invalid_components`, `to_and_recipients`, `invalid_recipients`, `duplicate_recipients`, `invalid_idempotency_key`, `missing_message_id`, `invalid_number`, `missing_numbers`, `too_many_numbers`, `invalid_numbers`, `missing_url`, `invalid_events`, `too_many_webhooks`, `invalid_template_name`, `invalid_template_language`, `invalid_template_category`, `invalid_template_components`, `invalid_reply_to`, `free_form_single_recipient`, `missing_text`, `invalid_text`, `invalid_send_at`, `send_at_in_past`, `send_at_too_far`, `invalid_time`, `invalid_limit`, `invalid_cursor`, `invalid_direction`, `invalid_status`, `invalid_phone`, `invalid_range`, `range_too_large`, `invalid_months`, `invalid_media_type`, `missing_file`, `missing_media`, `nothing_to_change`, `invalid_setting`, `segment_and_recipients`, `segment_empty`, `invalid_owner`, `invalid_contacts`, `invalid_segment`, `invalid_csv`, `too_many_segments`, `missing_interactive`, `invalid_interactive`, `invalid_test_event`, `invalid_keep_old_for_hours`, `invalid_contact_email`, `invalid_plan`, `invalid_key_request`, `invalid_estimate`, `invalid_analytics_query`, `invalid_conversion_events`, `invalid_booking`, `invalid_service`, `invalid_start`, `invalid_answers`, `invalid_addons`, `invalid_guests`, `invalid_series`, `invalid_block`, `invalid_note`, `invalid_link`, `invalid_slug`, `invalid_call_settings`, `invalid_call_request`, `invalid_wait`, `invalid_event_type`, `invalid_flow_id`, `invalid_flow_name`, `invalid_flow_categories`, `invalid_flow_json`, `invalid_flow_field`, `invalid_public_key`, `invalid_media_id`, `invalid_location`, `invalid_contacts_message`, `invalid_reaction`, `invalid_callback_data`, `caption_not_supported`, `invalid_marketing_api`, `invalid_users`, `invalid_bsuid`, `invalid_identity_key_hash`, `invalid_profile`, `invalid_display_name`, `invalid_oba_request`, `invalid_compliance_info`, `invalid_username`, `invalid_conversation_starters`, `invalid_qr_code`, `invalid_catalog_id`, `invalid_client_request`, `invalid_onboarding_request`, `invalid_redirect_url`, `invalid_partner_settings`, `invalid_payment`, `invalid_coupon`, `invalid_poll`, `shop_invalid`, `invalid_form`, `invalid_submission`, `invalid_automation`, `invalid_connection`, `invalid_member`, `invalid_list`, `invalid_setup`, `invalid_settings`, `template_language_required`, `invalid_template_field`, `invalid_optimization_spec`, `invalid_template_ids`, `too_many_templates`, `invalid_compare_days`, `invalid_auth_template`, `invalid_template_preview`, `invalid_library_filter`, `template_insights_confirm_required`, `invalid_insights_request`, `invalid_ticket_event`, `invalid_ticket_order`, `invalid_ticket_code`, `invalid_ticket_check_in`, `invalid_webhook_headers`, `invalid_webhook_format`, `invalid_webhook_secret`, `too_many_catchers` |
| 401 | Missing, invalid, revoked or expired API key. | `missing_api_key`, `invalid_authorization_header`, `invalid_api_key`, `api_key_old_format`, `api_key_revoked`, `api_key_expired` |
| 403 | The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account. | `api_key_number_mismatch`, `insufficient_scope`, `ip_not_allowed`, `plan_not_allowed`, `service_not_live`, `recipient_opted_out`, `recipient_not_opted_in`, `template_name_reserved`, `whatsapp_payment_issue`, `whatsapp_account_locked`, `whatsapp_account_restricted`, `sandbox_key`, `recipient_stopped_marketing`, `messaging_limit_restricted`, `display_name_not_approved`, `username_not_eligible`, `account_not_confirmed`, `account_deactivated`, `booking_not_enabled`, `link_not_usable`, `call_permission_required`, `not_in_instant_sandbox`, `flow_blocked_by_integrity`, `whatsapp_permission_missing`, `partner_suspended`, `partner_closed`, `client_not_editable`, `shop_not_enabled`, `submit_not_enabled`, `tickets_not_enabled` |
| 404 | The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found. | `number_not_found`, `template_not_found`, `template_language_not_found`, `message_not_found`, `broadcast_not_found`, `webhook_not_found`, `delivery_not_found`, `optin_not_found`, `request_not_found`, `conversation_not_found`, `contact_not_found`, `segment_not_found`, `approval_not_found`, `media_not_found`, `route_not_found`, `key_not_found`, `dataset_not_found`, `waitlist_not_found`, `booking_not_found`, `block_not_found`, `note_not_found`, `link_not_found`, `hold_not_found`, `flow_not_found`, `flow_json_not_found`, `qr_code_not_found`, `client_not_found`, `payment_not_found`, `package_not_found`, `poll_not_found`, `shop_not_found`, `form_not_found`, `submission_not_found`, `automation_not_found`, `connection_not_found`, `member_not_found`, `list_not_found`, `ticket_event_not_found`, `ticket_date_not_found`, `ticket_type_not_found`, `ticket_order_not_found`, `ticket_not_found`, `ticket_code_not_found`, `ticket_check_in_not_found`, `catcher_not_found` |
| 409 | Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published. | `idempotency_request_in_progress`, `idempotency_request_interrupted`, `template_already_exists`, `broadcast_not_cancellable`, `broadcast_cancelled`, `webhook_url_in_use`, `approval_already_resolved`, `approval_expired`, `segment_exists`, `number_already_verified`, `username_taken`, `number_not_live`, `key_limit_reached`, `key_limits_unavailable`, `plan_not_available`, `plan_already_active`, `waitlist_not_set_up`, `waitlist_not_offered`, `booking_slot_taken`, `booking_cancelled`, `hold_expired`, `slug_taken`, `flow_not_editable`, `flow_not_published`, `flow_not_deletable`, `flow_name_taken`, `encryption_key_managed`, `username_not_available`, `client_exists`, `payments_not_connected`, `refund_not_possible`, `too_late`, `shop_not_tracked`, `shop_sku_taken`, `shop_limit`, `shop_changed`, `shop_order_problems`, `form_not_published`, `form_has_submissions`, `form_exists`, `connection_in_use`, `stage_not_allowed`, `template_not_editable`, `template_category_locked`, `template_insights_not_enabled`, `tickets_not_on_sale`, `tickets_sold_out`, `ticket_seat_not_available`, `ticket_limit_reached`, `ticket_not_allowed`, `ticket_event_not_publishable`, `delivery_in_progress` |
| 415 | The body is not JSON. | `unsupported_content_type` |
| 429 | A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait. | `monthly_limit_reached`, `too_many_messages_to_recipient`, `whatsapp_rate_limit`, `rate_limited`, `daily_cap_reached`, `monthly_cap_reached`, `too_many_tests`, `register_limit_reached`, `too_many_signups`, `media_lookups_paused`, `too_many_invites` |
| 500 | Unexpected error on app2email's side. | `internal_error`, `background_start_failed`, `schedule_failed`, `shop_failed` |
| 503 | app2email's connection to the WhatsApp account needs attention, or the request log is not available right now. | `whatsapp_connection_problem`, `whatsapp_number_not_registered`, `request_log_unavailable`, `whatsapp_unavailable`, `whatsapp_maintenance`, `block_list_busy`, `account_service_unavailable`, `sandbox_unavailable`, `partner_service_unavailable`, `shop_not_ready`, `submit_not_ready` |

### 201

```json
{
  "success": true,
  "request_id": "f2crt",
  "form": {
    "id": 7,
    "key": "meter_reading",
    "name": "Meter reading",
    "enabled": true,
    "archived": false,
    "position": 0,
    "published": null,
    "changed": false,
    "flow": {
      "id": "",
      "status": "",
      "validation_errors": [],
      "checked_at": "",
      "last_error": "",
      "can_send": false
    },
    "links": {
      "web": "https://www.app2email.com/form/k3xbq9rtzp2mwv7/meter_reading",
      "wa_me": "https://wa.me/4976659348270?text=meter",
      "words": [
        "meter",
        "reading"
      ]
    },
    "counts": {
      "open": 0,
      "total": 0
    },
    "created": "2026-11-12T22:10:00.000Z",
    "updated": "2026-11-13T04:00:00.000Z",
    "definition": {
      "title": "Meter reading",
      "description": "Send us this month's reading.",
      "prefix": "MR",
      "steps": [
        {
          "key": "reading",
          "title": "Your reading",
          "text": "",
          "show_if": null,
          "fields": [
            {
              "key": "meter_no",
              "type": "text",
              "label": "Meter number",
              "help": "On the front of the meter",
              "required": true,
              "default": "{contact.meter_no}",
              "max_length": 20
            },
            {
              "key": "reading",
              "type": "number",
              "label": "Meter reading",
              "required": true,
              "min": 0,
              "max": 999999,
              "decimals": 0,
              "unit": "kWh"
            },
            {
              "key": "photo",
              "type": "photo",
              "label": "Photo of the meter",
              "required": true,
              "max_files": 1,
              "source": "camera"
            },
            {
              "key": "moving",
              "type": "yesno",
              "label": "Are you moving out?",
              "required": true
            },
            {
              "key": "billing_ref",
              "type": "text",
              "label": "Billing reference",
              "internal": true
            }
          ]
        },
        {
          "key": "move",
          "title": "Your move",
          "text": "We will close the account on that day.",
          "show_if": {
            "field": "moving",
            "equals": true
          },
          "fields": [
            {
              "key": "move_date",
              "type": "date",
              "label": "Moving date",
              "required": true,
              "min_days": -30,
              "max_days": 90
            },
            {
              "key": "new_address",
              "type": "textarea",
              "label": "New address for the final bill",
              "required": false,
              "max_length": 300
            }
          ]
        }
      ],
      "stages": [
        {
          "key": "received",
          "name": "Received",
          "kind": "open",
          "color": "blue",
          "set_by": [],
          "require_note": false,
          "message": ""
        },
        {
          "key": "queried",
          "name": "Queried",
          "kind": "open",
          "color": "amber",
          "set_by": [],
          "require_note": true,
          "message": "We have a question about your reading {reference}: {note}"
        },
        {
          "key": "checked",
          "name": "Checked",
          "kind": "done",
          "color": "green",
          "set_by": [
            "manager"
          ],
          "require_note": false,
          "message": "Thanks {contact.name}, your reading of {reading} kWh is recorded."
        }
      ],
      "who": {
        "mode": "anyone",
        "numbers": [],
        "tag": ""
      },
      "trigger": {
        "words": [
          "meter",
          "reading"
        ],
        "header": "",
        "body": "Tap the button to send your reading.",
        "button": "Open form",
        "footer": ""
      },
      "after": {
        "review_step": true,
        "reply": "Thanks {contact.name}. We have your {form} - reference {reference}.",
        "allow_additions": false,
        "status_page": true
      },
      "web": {
        "enabled": true,
        "verify": "optional",
        "ask_email": false,
        "success_text": ""
      },
      "notify": {
        "email": true,
        "to": [],
        "attach_files": true
      },
      "calculated": [
        {
          "key": "usage",
          "label": "Usage",
          "formula": "reading - previous('reading')",
          "unit": "kWh",
          "decimals": 0
        }
      ],
      "retention_days": 0
    },
    "fields": [
      {
        "key": "meter_no",
        "label": "Meter number",
        "type": "text",
        "step": "reading",
        "internal": false
      },
      {
        "key": "reading",
        "label": "Meter reading",
        "type": "number",
        "step": "reading",
        "internal": false,
        "unit": "kWh"
      },
      {
        "key": "photo",
        "label": "Photo of the meter",
        "type": "photo",
        "step": "reading",
        "internal": false
      },
      {
        "key": "moving",
        "label": "Are you moving out?",
        "type": "yesno",
        "step": "reading",
        "internal": false
      },
      {
        "key": "billing_ref",
        "label": "Billing reference",
        "type": "text",
        "step": "reading",
        "internal": true
      },
      {
        "key": "move_date",
        "label": "Moving date",
        "type": "date",
        "step": "move",
        "internal": false
      },
      {
        "key": "new_address",
        "label": "New address for the final bill",
        "type": "textarea",
        "step": "move",
        "internal": false
      },
      {
        "key": "usage",
        "label": "Usage",
        "type": "number",
        "step": "",
        "internal": true,
        "unit": "kWh",
        "calculated": true
      }
    ]
  }
}
```

## Errors

[`api_key_expired`](https://www.app2email.com/docs/api/errors#api_key_expired), [`api_key_number_mismatch`](https://www.app2email.com/docs/api/errors#api_key_number_mismatch), [`api_key_old_format`](https://www.app2email.com/docs/api/errors#api_key_old_format), [`api_key_revoked`](https://www.app2email.com/docs/api/errors#api_key_revoked), [`form_exists`](https://www.app2email.com/docs/api/errors#form_exists), [`insufficient_scope`](https://www.app2email.com/docs/api/errors#insufficient_scope), [`internal_error`](https://www.app2email.com/docs/api/errors#internal_error), [`invalid_api_key`](https://www.app2email.com/docs/api/errors#invalid_api_key), [`invalid_authorization_header`](https://www.app2email.com/docs/api/errors#invalid_authorization_header), [`invalid_form`](https://www.app2email.com/docs/api/errors#invalid_form), [`invalid_json`](https://www.app2email.com/docs/api/errors#invalid_json), [`invalid_number_in_url`](https://www.app2email.com/docs/api/errors#invalid_number_in_url), [`ip_not_allowed`](https://www.app2email.com/docs/api/errors#ip_not_allowed), [`missing_api_key`](https://www.app2email.com/docs/api/errors#missing_api_key), [`number_not_found`](https://www.app2email.com/docs/api/errors#number_not_found), [`plan_not_allowed`](https://www.app2email.com/docs/api/errors#plan_not_allowed), [`rate_limited`](https://www.app2email.com/docs/api/errors#rate_limited), [`sandbox_key`](https://www.app2email.com/docs/api/errors#sandbox_key), [`service_not_live`](https://www.app2email.com/docs/api/errors#service_not_live), [`submit_not_ready`](https://www.app2email.com/docs/api/errors#submit_not_ready)

## Example

```bash
curl -X POST "https://api.app2email.com/v1/YOUR_NUMBER/submit/forms" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "meter_reading",
  "name": "Meter reading",
  "definition": {
    "title": "Meter reading",
    "description": "Send us this month'\''s reading.",
    "prefix": "MR",
    "steps": [
      {
        "key": "reading",
        "title": "Your reading",
        "text": "",
        "show_if": null,
        "fields": [
          {
            "key": "meter_no",
            "type": "text",
            "label": "Meter number",
            "help": "On the front of the meter",
            "required": true,
            "default": "{contact.meter_no}",
            "max_length": 20
          },
          {
            "key": "reading",
            "type": "number",
            "label": "Meter reading",
            "required": true,
            "min": 0,
            "max": 999999,
            "decimals": 0,
            "unit": "kWh"
          },
          {
            "key": "photo",
            "type": "photo",
            "label": "Photo of the meter",
            "required": true,
            "max_files": 1,
            "source": "camera"
          },
          {
            "key": "moving",
            "type": "yesno",
            "label": "Are you moving out?",
            "required": true
          },
          {
            "key": "billing_ref",
            "type": "text",
            "label": "Billing reference",
            "internal": true
          }
        ]
      },
      {
        "key": "move",
        "title": "Your move",
        "text": "We will close the account on that day.",
        "show_if": { "field": "moving", "equals": true },
        "fields": [
          {
            "key": "move_date",
            "type": "date",
            "label": "Moving date",
            "required": true,
            "min_days": -30,
            "max_days": 90
          },
          {
            "key": "new_address",
            "type": "textarea",
            "label": "New address for the final bill",
            "required": false,
            "max_length": 300
          }
        ]
      }
    ],
    "stages": [
      {
        "key": "received",
        "name": "Received",
        "kind": "open",
        "color": "blue",
        "set_by": [],
        "require_note": false,
        "message": ""
      },
      {
        "key": "queried",
        "name": "Queried",
        "kind": "open",
        "color": "amber",
        "set_by": [],
        "require_note": true,
        "message": "We have a question about your reading {reference}: {note}"
      },
      {
        "key": "checked",
        "name": "Checked",
        "kind": "done",
        "color": "green",
        "set_by": ["manager"],
        "require_note": false,
        "message": "Thanks {contact.name}, your reading of {reading} kWh is recorded."
      }
    ],
    "who": { "mode": "anyone", "numbers": [], "tag": "" },
    "trigger": {
      "words": ["meter", "reading"],
      "header": "",
      "body": "Tap the button to send your reading.",
      "button": "Open form",
      "footer": ""
    },
    "after": {
      "review_step": true,
      "reply": "Thanks {contact.name}. We have your {form} - reference {reference}.",
      "allow_additions": false,
      "status_page": true
    },
    "web": {
      "enabled": true,
      "verify": "optional",
      "ask_email": false,
      "success_text": ""
    },
    "notify": { "email": true, "to": [], "attach_files": true },
    "calculated": [
      {
        "key": "usage",
        "label": "Usage",
        "formula": "reading - previous('\''reading'\'')",
        "unit": "kWh",
        "decimals": 0
      }
    ],
    "retention_days": 0
  }
}'
```

## OpenAPI

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "app2email WhatsApp API",
    "version": "1.4.0"
  },
  "servers": [
    {
      "url": "https://api.app2email.com"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/v1/{number}/submit/forms": {
      "post": {
        "tags": [
          "Submit-Info"
        ],
        "operationId": "createForm",
        "summary": "Create a form from a definition or a preset",
        "description": "Scope: `submissions:manage`. Not with a sandbox key. Send `name` and `definition` (the SubmitFormDefinition schema explains every key; a minimal form is a title and one step with one field). `name` alone makes a starter form with one question to change. `preset` installs a ready-made solution instead: its form with the lists and automations that belong to it (`applied` in the answer names them). The definition is checked as a whole: 400 `invalid_form` lists every problem with its path (`definition.steps[0].fields[1].label`) and a fix, and nothing is saved. The answer is the form with its normalized definition and its links. The web page works at once; to open the form inside WhatsApp call POST /submit/forms/{key}/publish next. A number has at most 100 forms.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Number"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubmitFormCreateRequest"
              },
              "example": {
                "key": "meter_reading",
                "name": "Meter reading",
                "definition": {
                  "title": "Meter reading",
                  "description": "Send us this month's reading.",
                  "prefix": "MR",
                  "steps": [
                    {
                      "key": "reading",
                      "title": "Your reading",
                      "text": "",
                      "show_if": null,
                      "fields": [
                        {
                          "key": "meter_no",
                          "type": "text",
                          "label": "Meter number",
                          "help": "On the front of the meter",
                          "required": true,
                          "default": "{contact.meter_no}",
                          "max_length": 20
                        },
                        {
                          "key": "reading",
                          "type": "number",
                          "label": "Meter reading",
                          "required": true,
                          "min": 0,
                          "max": 999999,
                          "decimals": 0,
                          "unit": "kWh"
                        },
                        {
                          "key": "photo",
                          "type": "photo",
                          "label": "Photo of the meter",
                          "required": true,
                          "max_files": 1,
                          "source": "camera"
                        },
                        {
                          "key": "moving",
                          "type": "yesno",
                          "label": "Are you moving out?",
                          "required": true
                        },
                        {
                          "key": "billing_ref",
                          "type": "text",
                          "label": "Billing reference",
                          "internal": true
                        }
                      ]
                    },
                    {
                      "key": "move",
                      "title": "Your move",
                      "text": "We will close the account on that day.",
                      "show_if": {
                        "field": "moving",
                        "equals": true
                      },
                      "fields": [
                        {
                          "key": "move_date",
                          "type": "date",
                          "label": "Moving date",
                          "required": true,
                          "min_days": -30,
                          "max_days": 90
                        },
                        {
                          "key": "new_address",
                          "type": "textarea",
                          "label": "New address for the final bill",
                          "required": false,
                          "max_length": 300
                        }
                      ]
                    }
                  ],
                  "stages": [
                    {
                      "key": "received",
                      "name": "Received",
                      "kind": "open",
                      "color": "blue",
                      "set_by": [],
                      "require_note": false,
                      "message": ""
                    },
                    {
                      "key": "queried",
                      "name": "Queried",
                      "kind": "open",
                      "color": "amber",
                      "set_by": [],
                      "require_note": true,
                      "message": "We have a question about your reading {reference}: {note}"
                    },
                    {
                      "key": "checked",
                      "name": "Checked",
                      "kind": "done",
                      "color": "green",
                      "set_by": [
                        "manager"
                      ],
                      "require_note": false,
                      "message": "Thanks {contact.name}, your reading of {reading} kWh is recorded."
                    }
                  ],
                  "who": {
                    "mode": "anyone",
                    "numbers": [],
                    "tag": ""
                  },
                  "trigger": {
                    "words": [
                      "meter",
                      "reading"
                    ],
                    "header": "",
                    "body": "Tap the button to send your reading.",
                    "button": "Open form",
                    "footer": ""
                  },
                  "after": {
                    "review_step": true,
                    "reply": "Thanks {contact.name}. We have your {form} - reference {reference}.",
                    "allow_additions": false,
                    "status_page": true
                  },
                  "web": {
                    "enabled": true,
                    "verify": "optional",
                    "ask_email": false,
                    "success_text": ""
                  },
                  "notify": {
                    "email": true,
                    "to": [],
                    "attach_files": true
                  },
                  "calculated": [
                    {
                      "key": "usage",
                      "label": "Usage",
                      "formula": "reading - previous('reading')",
                      "unit": "kWh",
                      "decimals": 0
                    }
                  ],
                  "retention_days": 0
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Made.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubmitFormResponse"
                },
                "example": {
                  "success": true,
                  "request_id": "f2crt",
                  "form": {
                    "id": 7,
                    "key": "meter_reading",
                    "name": "Meter reading",
                    "enabled": true,
                    "archived": false,
                    "position": 0,
                    "published": null,
                    "changed": false,
                    "flow": {
                      "id": "",
                      "status": "",
                      "validation_errors": [],
                      "checked_at": "",
                      "last_error": "",
                      "can_send": false
                    },
                    "links": {
                      "web": "https://www.app2email.com/form/k3xbq9rtzp2mwv7/meter_reading",
                      "wa_me": "https://wa.me/4976659348270?text=meter",
                      "words": [
                        "meter",
                        "reading"
                      ]
                    },
                    "counts": {
                      "open": 0,
                      "total": 0
                    },
                    "created": "2026-11-12T22:10:00.000Z",
                    "updated": "2026-11-13T04:00:00.000Z",
                    "definition": {
                      "title": "Meter reading",
                      "description": "Send us this month's reading.",
                      "prefix": "MR",
                      "steps": [
                        {
                          "key": "reading",
                          "title": "Your reading",
                          "text": "",
                          "show_if": null,
                          "fields": [
                            {
                              "key": "meter_no",
                              "type": "text",
                              "label": "Meter number",
                              "help": "On the front of the meter",
                              "required": true,
                              "default": "{contact.meter_no}",
                              "max_length": 20
                            },
                            {
                              "key": "reading",
                              "type": "number",
                              "label": "Meter reading",
                              "required": true,
                              "min": 0,
                              "max": 999999,
                              "decimals": 0,
                              "unit": "kWh"
                            },
                            {
                              "key": "photo",
                              "type": "photo",
                              "label": "Photo of the meter",
                              "required": true,
                              "max_files": 1,
                              "source": "camera"
                            },
                            {
                              "key": "moving",
                              "type": "yesno",
                              "label": "Are you moving out?",
                              "required": true
                            },
                            {
                              "key": "billing_ref",
                              "type": "text",
                              "label": "Billing reference",
                              "internal": true
                            }
                          ]
                        },
                        {
                          "key": "move",
                          "title": "Your move",
                          "text": "We will close the account on that day.",
                          "show_if": {
                            "field": "moving",
                            "equals": true
                          },
                          "fields": [
                            {
                              "key": "move_date",
                              "type": "date",
                              "label": "Moving date",
                              "required": true,
                              "min_days": -30,
                              "max_days": 90
                            },
                            {
                              "key": "new_address",
                              "type": "textarea",
                              "label": "New address for the final bill",
                              "required": false,
                              "max_length": 300
                            }
                          ]
                        }
                      ],
                      "stages": [
                        {
                          "key": "received",
                          "name": "Received",
                          "kind": "open",
                          "color": "blue",
                          "set_by": [],
                          "require_note": false,
                          "message": ""
                        },
                        {
                          "key": "queried",
                          "name": "Queried",
                          "kind": "open",
                          "color": "amber",
                          "set_by": [],
                          "require_note": true,
                          "message": "We have a question about your reading {reference}: {note}"
                        },
                        {
                          "key": "checked",
                          "name": "Checked",
                          "kind": "done",
                          "color": "green",
                          "set_by": [
                            "manager"
                          ],
                          "require_note": false,
                          "message": "Thanks {contact.name}, your reading of {reading} kWh is recorded."
                        }
                      ],
                      "who": {
                        "mode": "anyone",
                        "numbers": [],
                        "tag": ""
                      },
                      "trigger": {
                        "words": [
                          "meter",
                          "reading"
                        ],
                        "header": "",
                        "body": "Tap the button to send your reading.",
                        "button": "Open form",
                        "footer": ""
                      },
                      "after": {
                        "review_step": true,
                        "reply": "Thanks {contact.name}. We have your {form} - reference {reference}.",
                        "allow_additions": false,
                        "status_page": true
                      },
                      "web": {
                        "enabled": true,
                        "verify": "optional",
                        "ask_email": false,
                        "success_text": ""
                      },
                      "notify": {
                        "email": true,
                        "to": [],
                        "attach_files": true
                      },
                      "calculated": [
                        {
                          "key": "usage",
                          "label": "Usage",
                          "formula": "reading - previous('reading')",
                          "unit": "kWh",
                          "decimals": 0
                        }
                      ],
                      "retention_days": 0
                    },
                    "fields": [
                      {
                        "key": "meter_no",
                        "label": "Meter number",
                        "type": "text",
                        "step": "reading",
                        "internal": false
                      },
                      {
                        "key": "reading",
                        "label": "Meter reading",
                        "type": "number",
                        "step": "reading",
                        "internal": false,
                        "unit": "kWh"
                      },
                      {
                        "key": "photo",
                        "label": "Photo of the meter",
                        "type": "photo",
                        "step": "reading",
                        "internal": false
                      },
                      {
                        "key": "moving",
                        "label": "Are you moving out?",
                        "type": "yesno",
                        "step": "reading",
                        "internal": false
                      },
                      {
                        "key": "billing_ref",
                        "label": "Billing reference",
                        "type": "text",
                        "step": "reading",
                        "internal": true
                      },
                      {
                        "key": "move_date",
                        "label": "Moving date",
                        "type": "date",
                        "step": "move",
                        "internal": false
                      },
                      {
                        "key": "new_address",
                        "label": "New address for the final bill",
                        "type": "textarea",
                        "step": "move",
                        "internal": false
                      },
                      {
                        "key": "usage",
                        "label": "Usage",
                        "type": "number",
                        "step": "",
                        "internal": true,
                        "unit": "kWh",
                        "calculated": true
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request is malformed (missing or invalid fields, query parameters or times). Possible error.code values: invalid_number_in_url, invalid_json, unsupported_message_type, invalid_to, too_many_recipients, missing_template_name, missing_template_language, invalid_components, to_and_recipients, invalid_recipients, duplicate_recipients, invalid_idempotency_key, missing_message_id, invalid_number, missing_numbers, too_many_numbers, invalid_numbers, missing_url, invalid_events, too_many_webhooks, invalid_template_name, invalid_template_language, invalid_template_category, invalid_template_components, invalid_reply_to, free_form_single_recipient, missing_text, invalid_text, invalid_send_at, send_at_in_past, send_at_too_far, invalid_time, invalid_limit, invalid_cursor, invalid_direction, invalid_status, invalid_phone, invalid_range, range_too_large, invalid_months, invalid_media_type, missing_file, missing_media, nothing_to_change, invalid_setting, segment_and_recipients, segment_empty, invalid_owner, invalid_contacts, invalid_segment, invalid_csv, too_many_segments, missing_interactive, invalid_interactive, invalid_test_event, invalid_keep_old_for_hours, invalid_contact_email, invalid_plan, invalid_key_request, invalid_estimate, invalid_analytics_query, invalid_conversion_events, invalid_booking, invalid_service, invalid_start, invalid_answers, invalid_addons, invalid_guests, invalid_series, invalid_block, invalid_note, invalid_link, invalid_slug, invalid_call_settings, invalid_call_request, invalid_wait, invalid_event_type, invalid_flow_id, invalid_flow_name, invalid_flow_categories, invalid_flow_json, invalid_flow_field, invalid_public_key, invalid_media_id, invalid_location, invalid_contacts_message, invalid_reaction, invalid_callback_data, caption_not_supported, invalid_marketing_api, invalid_users, invalid_bsuid, invalid_identity_key_hash, invalid_profile, invalid_display_name, invalid_oba_request, invalid_compliance_info, invalid_username, invalid_conversation_starters, invalid_qr_code, invalid_catalog_id, invalid_client_request, invalid_onboarding_request, invalid_redirect_url, invalid_partner_settings, invalid_payment, invalid_coupon, invalid_poll, shop_invalid, invalid_form, invalid_submission, invalid_automation, invalid_connection, invalid_member, invalid_list, invalid_setup, invalid_settings, template_language_required, invalid_template_field, invalid_optimization_spec, invalid_template_ids, too_many_templates, invalid_compare_days, invalid_auth_template, invalid_template_preview, invalid_library_filter, template_insights_confirm_required, invalid_insights_request, invalid_ticket_event, invalid_ticket_order, invalid_ticket_code, invalid_ticket_check_in, invalid_webhook_headers, invalid_webhook_format, invalid_webhook_secret, too_many_catchers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing, invalid, revoked or expired API key. Possible error.code values: missing_api_key, invalid_authorization_header, invalid_api_key, api_key_old_format, api_key_revoked, api_key_expired.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account. Possible error.code values: api_key_number_mismatch, insufficient_scope, ip_not_allowed, plan_not_allowed, service_not_live, recipient_opted_out, recipient_not_opted_in, template_name_reserved, whatsapp_payment_issue, whatsapp_account_locked, whatsapp_account_restricted, sandbox_key, recipient_stopped_marketing, messaging_limit_restricted, display_name_not_approved, username_not_eligible, account_not_confirmed, account_deactivated, booking_not_enabled, link_not_usable, call_permission_required, not_in_instant_sandbox, flow_blocked_by_integrity, whatsapp_permission_missing, partner_suspended, partner_closed, client_not_editable, shop_not_enabled, submit_not_enabled, tickets_not_enabled.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found. Possible error.code values: number_not_found, template_not_found, template_language_not_found, message_not_found, broadcast_not_found, webhook_not_found, delivery_not_found, optin_not_found, request_not_found, conversation_not_found, contact_not_found, segment_not_found, approval_not_found, media_not_found, route_not_found, key_not_found, dataset_not_found, waitlist_not_found, booking_not_found, block_not_found, note_not_found, link_not_found, hold_not_found, flow_not_found, flow_json_not_found, qr_code_not_found, client_not_found, payment_not_found, package_not_found, poll_not_found, shop_not_found, form_not_found, submission_not_found, automation_not_found, connection_not_found, member_not_found, list_not_found, ticket_event_not_found, ticket_date_not_found, ticket_type_not_found, ticket_order_not_found, ticket_not_found, ticket_code_not_found, ticket_check_in_not_found, catcher_not_found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published. Possible error.code values: idempotency_request_in_progress, idempotency_request_interrupted, template_already_exists, broadcast_not_cancellable, broadcast_cancelled, webhook_url_in_use, approval_already_resolved, approval_expired, segment_exists, number_already_verified, username_taken, number_not_live, key_limit_reached, key_limits_unavailable, plan_not_available, plan_already_active, waitlist_not_set_up, waitlist_not_offered, booking_slot_taken, booking_cancelled, hold_expired, slug_taken, flow_not_editable, flow_not_published, flow_not_deletable, flow_name_taken, encryption_key_managed, username_not_available, client_exists, payments_not_connected, refund_not_possible, too_late, shop_not_tracked, shop_sku_taken, shop_limit, shop_changed, shop_order_problems, form_not_published, form_has_submissions, form_exists, connection_in_use, stage_not_allowed, template_not_editable, template_category_locked, template_insights_not_enabled, tickets_not_on_sale, tickets_sold_out, ticket_seat_not_available, ticket_limit_reached, ticket_not_allowed, ticket_event_not_publishable, delivery_in_progress.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "415": {
            "description": "The body is not JSON. Possible error.code values: unsupported_content_type.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait. Possible error.code values: monthly_limit_reached, too_many_messages_to_recipient, whatsapp_rate_limit, rate_limited, daily_cap_reached, monthly_cap_reached, too_many_tests, register_limit_reached, too_many_signups, media_lookups_paused, too_many_invites.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected error on app2email's side. Possible error.code values: internal_error, background_start_failed, schedule_failed, shop_failed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "app2email's connection to the WhatsApp account needs attention, or the request log is not available right now. Possible error.code values: whatsapp_connection_problem, whatsapp_number_not_registered, request_log_unavailable, whatsapp_unavailable, whatsapp_maintenance, block_list_busy, account_service_unavailable, sandbox_unavailable, partner_service_unavailable, shop_not_ready, submit_not_ready.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "x-a2e-webhook-events": [],
        "x-a2e-error-codes": [
          "api_key_expired",
          "api_key_number_mismatch",
          "api_key_old_format",
          "api_key_revoked",
          "form_exists",
          "insufficient_scope",
          "internal_error",
          "invalid_api_key",
          "invalid_authorization_header",
          "invalid_form",
          "invalid_json",
          "invalid_number_in_url",
          "ip_not_allowed",
          "missing_api_key",
          "number_not_found",
          "plan_not_allowed",
          "rate_limited",
          "sandbox_key",
          "service_not_live",
          "submit_not_ready"
        ],
        "x-a2e-scope": "submissions:manage",
        "x-a2e-sandbox": "refused",
        "x-a2e-mcp-tool": "create_form",
        "x-a2e-needs": null
      }
    }
  },
  "components": {
    "parameters": {
      "Number": {
        "name": "number",
        "in": "path",
        "required": true,
        "description": "Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.",
        "schema": {
          "type": "string",
          "pattern": "^[0-9]{8,15}$",
          "example": "4976659348270"
        }
      }
    },
    "schemas": {
      "AudioContent": {
        "type": "object",
        "description": "aac, amr, mp3, m4a or ogg (OPUS), up to 16 MB. No caption.",
        "properties": {
          "link": {
            "type": "string",
            "format": "uri",
            "description": "Public http(s) URL. app2email downloads the file and uploads it to WhatsApp."
          },
          "data": {
            "type": "string",
            "format": "byte",
            "description": "The file, base64 encoded."
          },
          "id": {
            "type": "string",
            "description": "A media id from POST /media."
          },
          "filename": {
            "type": "string"
          },
          "mime_type": {
            "type": "string"
          },
          "voice": {
            "type": "boolean",
            "description": "true: a voice message (play button, transcript). Ogg with the OPUS codec only; app2email does not convert."
          }
        }
      },
      "Component": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "header",
              "body",
              "button",
              "carousel",
              "limited_time_offer"
            ]
          },
          "sub_type": {
            "type": "string",
            "enum": [
              "url",
              "quick_reply",
              "copy_code",
              "flow",
              "catalog",
              "mpm",
              "spm",
              "order_details"
            ],
            "description": "Buttons only."
          },
          "index": {
            "type": "string",
            "example": "0",
            "description": "Buttons only: position of the button in the template, starting at 0."
          },
          "parameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Parameter"
            }
          },
          "cards": {
            "type": "array",
            "description": "type 'carousel': one entry per card of the approved template, {card_index, components: [header, body, button...]}.",
            "items": {
              "type": "object",
              "properties": {
                "card_index": {
                  "type": "integer"
                },
                "components": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Component"
                  }
                }
              }
            }
          }
        }
      },
      "ContactCard": {
        "type": "object",
        "required": [
          "name"
        ],
        "description": "One vCard, as WhatsApp Cloud API.",
        "properties": {
          "name": {
            "type": "object",
            "required": [
              "formatted_name"
            ],
            "properties": {
              "formatted_name": {
                "type": "string",
                "example": "Jane Citizen"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "middle_name": {
                "type": "string"
              },
              "prefix": {
                "type": "string"
              },
              "suffix": {
                "type": "string"
              }
            }
          },
          "phones": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "phone": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "example": "CELL"
                },
                "wa_id": {
                  "type": "string"
                }
              }
            }
          },
          "emails": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              }
            }
          },
          "addresses": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "org": {
            "type": "object",
            "properties": {
              "company": {
                "type": "string"
              },
              "department": {
                "type": "string"
              },
              "title": {
                "type": "string"
              }
            }
          },
          "urls": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              }
            }
          },
          "birthday": {
            "type": "string",
            "example": "1990-01-31"
          }
        }
      },
      "Currency": {
        "type": "object",
        "properties": {
          "fallback_value": {
            "type": "string",
            "example": "$10.50"
          },
          "code": {
            "type": "string",
            "example": "USD"
          },
          "amount_1000": {
            "type": "integer",
            "example": 10500
          }
        }
      },
      "DateTime": {
        "type": "object",
        "properties": {
          "fallback_value": {
            "type": "string",
            "example": "February 25, 2026"
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code",
          "message",
          "how_to_fix"
        ],
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "account_deactivated",
              "account_not_confirmed",
              "account_service_error",
              "account_service_unavailable",
              "api_key_expired",
              "api_key_number_mismatch",
              "api_key_old_format",
              "api_key_revoked",
              "approval_already_resolved",
              "approval_body_too_large",
              "approval_expired",
              "approval_not_found",
              "automation_not_found",
              "background_start_failed",
              "block_list_busy",
              "block_list_full",
              "block_not_found",
              "block_users_error",
              "block_users_failed",
              "booking_cancelled",
              "booking_not_enabled",
              "booking_not_found",
              "booking_slot_taken",
              "broadcast_cancelled",
              "broadcast_not_cancellable",
              "broadcast_not_found",
              "bsuid_not_supported",
              "call_permission_required",
              "caption_not_supported",
              "caption_too_long",
              "catcher_not_found",
              "client_exists",
              "client_not_editable",
              "client_not_found",
              "connection_failed",
              "connection_in_use",
              "connection_not_found",
              "contact_book_error",
              "contact_not_found",
              "conversation_not_found",
              "daily_cap_reached",
              "dataset_not_found",
              "delivery_in_progress",
              "delivery_not_found",
              "display_name_not_approved",
              "duplicate_recipients",
              "email_not_sent",
              "encryption_key_managed",
              "flow_blocked_by_integrity",
              "flow_cannot_publish",
              "flow_json_download_failed",
              "flow_json_not_found",
              "flow_json_too_large",
              "flow_name_taken",
              "flow_not_deletable",
              "flow_not_editable",
              "flow_not_found",
              "flow_not_published",
              "flow_rejected",
              "form_exists",
              "form_has_submissions",
              "form_not_found",
              "form_not_published",
              "free_form_single_recipient",
              "hold_expired",
              "hold_not_found",
              "idempotency_key_reused",
              "idempotency_request_in_progress",
              "idempotency_request_interrupted",
              "insufficient_scope",
              "internal_error",
              "invalid_addons",
              "invalid_analytics_query",
              "invalid_answers",
              "invalid_api_key",
              "invalid_auth_template",
              "invalid_authorization_header",
              "invalid_automation",
              "invalid_base64",
              "invalid_block",
              "invalid_booking",
              "invalid_bsuid",
              "invalid_call_request",
              "invalid_call_settings",
              "invalid_callback_data",
              "invalid_catalog_id",
              "invalid_client_request",
              "invalid_compare_days",
              "invalid_compliance_info",
              "invalid_components",
              "invalid_connection",
              "invalid_contact_email",
              "invalid_contacts",
              "invalid_contacts_message",
              "invalid_conversation_starters",
              "invalid_conversion_events",
              "invalid_coupon",
              "invalid_csv",
              "invalid_cursor",
              "invalid_direction",
              "invalid_display_name",
              "invalid_email",
              "invalid_estimate",
              "invalid_event_type",
              "invalid_events",
              "invalid_flow_categories",
              "invalid_flow_field",
              "invalid_flow_id",
              "invalid_flow_json",
              "invalid_flow_name",
              "invalid_form",
              "invalid_guests",
              "invalid_idempotency_key",
              "invalid_identity_key_hash",
              "invalid_insights_request",
              "invalid_interactive",
              "invalid_json",
              "invalid_keep_old_for_hours",
              "invalid_key_request",
              "invalid_library_filter",
              "invalid_limit",
              "invalid_link",
              "invalid_list",
              "invalid_location",
              "invalid_marketing_api",
              "invalid_media_id",
              "invalid_media_link",
              "invalid_media_type",
              "invalid_member",
              "invalid_months",
              "invalid_note",
              "invalid_number",
              "invalid_number_in_url",
              "invalid_numbers",
              "invalid_oba_request",
              "invalid_onboarding_request",
              "invalid_optimization_spec",
              "invalid_owner",
              "invalid_partner_settings",
              "invalid_payment",
              "invalid_phone",
              "invalid_plan",
              "invalid_poll",
              "invalid_profile",
              "invalid_public_key",
              "invalid_qr_code",
              "invalid_range",
              "invalid_reaction",
              "invalid_recipients",
              "invalid_redirect_url",
              "invalid_reply_to",
              "invalid_segment",
              "invalid_send_at",
              "invalid_series",
              "invalid_service",
              "invalid_setting",
              "invalid_settings",
              "invalid_setup",
              "invalid_slug",
              "invalid_start",
              "invalid_status",
              "invalid_submission",
              "invalid_template_category",
              "invalid_template_components",
              "invalid_template_field",
              "invalid_template_ids",
              "invalid_template_language",
              "invalid_template_name",
              "invalid_template_preview",
              "invalid_test_event",
              "invalid_text",
              "invalid_ticket_check_in",
              "invalid_ticket_code",
              "invalid_ticket_event",
              "invalid_ticket_order",
              "invalid_time",
              "invalid_to",
              "invalid_username",
              "invalid_users",
              "invalid_wait",
              "invalid_webhook_format",
              "invalid_webhook_headers",
              "invalid_webhook_secret",
              "invalid_webhook_url",
              "ip_not_allowed",
              "key_limit_reached",
              "key_limits_unavailable",
              "key_not_found",
              "link_not_found",
              "link_not_usable",
              "list_not_found",
              "marketing_disabled_on_cloud_api",
              "marketing_per_user_limit",
              "marketing_status_lookup_failed",
              "media_delete_failed",
              "media_download_error",
              "media_download_failed",
              "media_lookup_failed",
              "media_lookups_paused",
              "media_not_found",
              "media_too_large",
              "media_type_not_allowed",
              "media_upload_error",
              "media_upload_failed",
              "member_not_found",
              "message_not_found",
              "message_too_old",
              "messaging_limit_restricted",
              "missing_api_key",
              "missing_file",
              "missing_interactive",
              "missing_media",
              "missing_message_id",
              "missing_numbers",
              "missing_template_language",
              "missing_template_name",
              "missing_text",
              "missing_url",
              "monthly_cap_reached",
              "monthly_limit_reached",
              "not_in_instant_sandbox",
              "note_not_found",
              "nothing_to_change",
              "number_already_verified",
              "number_not_found",
              "number_not_live",
              "optin_not_found",
              "outside_24h_window",
              "package_not_found",
              "parameter_value_invalid",
              "partner_closed",
              "partner_service_unavailable",
              "partner_suspended",
              "payment_link_failed",
              "payment_not_found",
              "payment_provider_error",
              "payments_not_connected",
              "plan_already_active",
              "plan_not_allowed",
              "plan_not_available",
              "poll_not_found",
              "profile_photo_failed",
              "qr_code_not_found",
              "range_too_large",
              "rate_limited",
              "reaction_too_old",
              "recipient_identity_changed",
              "recipient_in_experiment",
              "recipient_is_sender",
              "recipient_not_allowed",
              "recipient_not_opted_in",
              "recipient_opted_out",
              "recipient_stopped_marketing",
              "recipient_unreachable",
              "refund_not_possible",
              "register_limit_reached",
              "request_log_unavailable",
              "request_not_found",
              "request_too_large",
              "required_parameter_missing",
              "route_not_found",
              "sandbox_key",
              "sandbox_recipient",
              "sandbox_unavailable",
              "schedule_failed",
              "segment_and_recipients",
              "segment_empty",
              "segment_exists",
              "segment_not_found",
              "send_at_in_past",
              "send_at_too_far",
              "service_not_live",
              "shop_changed",
              "shop_failed",
              "shop_invalid",
              "shop_limit",
              "shop_not_enabled",
              "shop_not_found",
              "shop_not_ready",
              "shop_not_tracked",
              "shop_order_problems",
              "shop_payment_failed",
              "shop_sku_taken",
              "slug_taken",
              "stage_not_allowed",
              "submission_not_found",
              "submit_not_enabled",
              "submit_not_ready",
              "template_already_exists",
              "template_archive_failed",
              "template_category_locked",
              "template_compare_unavailable",
              "template_delete_failed",
              "template_disabled",
              "template_format_policy",
              "template_insights_confirm_required",
              "template_insights_not_enabled",
              "template_insights_unavailable",
              "template_language_not_found",
              "template_language_required",
              "template_limit_reached",
              "template_lookup_failed",
              "template_name_reserved",
              "template_not_approved",
              "template_not_editable",
              "template_not_found",
              "template_not_marketing",
              "template_parameter_count_mismatch",
              "template_parameter_format_mismatch",
              "template_parameter_invalid",
              "template_parameters_invalid",
              "template_paused",
              "template_rejected",
              "template_sample_media_failed",
              "template_text_too_long",
              "template_unarchive_failed",
              "test_event_too_large",
              "text_too_long",
              "ticket_check_in_not_found",
              "ticket_code_not_found",
              "ticket_date_not_found",
              "ticket_event_not_found",
              "ticket_event_not_publishable",
              "ticket_limit_reached",
              "ticket_not_allowed",
              "ticket_not_found",
              "ticket_order_not_found",
              "ticket_seat_not_available",
              "ticket_type_not_found",
              "tickets_not_enabled",
              "tickets_not_on_sale",
              "tickets_sold_out",
              "to_and_recipients",
              "too_late",
              "too_many_catchers",
              "too_many_invites",
              "too_many_messages_to_recipient",
              "too_many_numbers",
              "too_many_recipients",
              "too_many_segments",
              "too_many_signups",
              "too_many_templates",
              "too_many_tests",
              "too_many_webhooks",
              "unsupported_content_type",
              "unsupported_message_type",
              "username_account_not_linked",
              "username_change_limit",
              "username_not_available",
              "username_not_eligible",
              "username_taken",
              "voice_needs_ogg_opus",
              "waitlist_not_found",
              "waitlist_not_offered",
              "waitlist_not_set_up",
              "webhook_not_found",
              "webhook_url_in_use",
              "whatsapp_account_locked",
              "whatsapp_account_restricted",
              "whatsapp_connection_problem",
              "whatsapp_error",
              "whatsapp_flow_failed",
              "whatsapp_maintenance",
              "whatsapp_number_not_registered",
              "whatsapp_parameter_error",
              "whatsapp_payment_issue",
              "whatsapp_permission_missing",
              "whatsapp_rate_limit",
              "whatsapp_unavailable"
            ],
            "description": "Stable error code, safe to use in your own logic."
          },
          "message": {
            "type": "string",
            "description": "What is wrong, in plain words."
          },
          "how_to_fix": {
            "type": "string",
            "description": "What to change to make the request work."
          },
          "documentation_url": {
            "type": "string",
            "example": "https://www.app2email.com/docs/api/errors#template_not_found",
            "description": "Where this error is explained."
          },
          "is_retriable": {
            "type": "boolean",
            "description": "true: the same request can work later without a change (limits, caps, trouble on our side or WhatsApp's, a request with the same Idempotency-Key still running)."
          },
          "retry_after_seconds": {
            "type": "integer",
            "description": "How long to wait before trying again, when known (also the Retry-After header)."
          },
          "details": {
            "type": "object",
            "additionalProperties": true,
            "description": "Extra information, eg the problems found, available templates or languages."
          },
          "example_request": {
            "$ref": "#/components/schemas/SendTemplateRequest"
          },
          "whatsapp_error": {
            "$ref": "#/components/schemas/WhatsAppError"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "request_id": {
            "type": "string",
            "example": "kxrkf",
            "description": "Quote this when contacting support."
          },
          "error": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "FreeFormMedia": {
        "type": "object",
        "description": "Give exactly one of: link, data or id. 'filename' is shown to the recipient for documents.",
        "properties": {
          "link": {
            "type": "string",
            "format": "uri",
            "example": "https://example.com/photo.jpg",
            "description": "Public http(s) URL. app2email downloads the file and uploads it to WhatsApp."
          },
          "data": {
            "type": "string",
            "format": "byte",
            "description": "The file, base64 encoded. A 'data:<mime>;base64,' prefix is accepted."
          },
          "id": {
            "type": "string",
            "description": "A media id from POST /media (or uploaded to WhatsApp for this number)."
          },
          "filename": {
            "type": "string",
            "example": "invoice.pdf",
            "description": "Needed with 'data' for documents."
          },
          "mime_type": {
            "type": "string",
            "example": "application/pdf",
            "description": "Optional. The type is detected from the file where possible."
          },
          "caption": {
            "type": "string",
            "maxLength": 1024,
            "example": "Your parcel",
            "description": "Optional text under the image, video or document."
          }
        }
      },
      "FreeFormText": {
        "type": "object",
        "required": [
          "body"
        ],
        "properties": {
          "body": {
            "type": "string",
            "example": "Thanks, it arrives on Friday.",
            "description": "The text. Up to 4096 characters."
          },
          "preview_url": {
            "type": "boolean",
            "default": false,
            "description": "true: show a preview of a link in the text."
          }
        }
      },
      "Interactive": {
        "type": "object",
        "required": [
          "type",
          "action"
        ],
        "description": "WhatsApp's interactive object. type button: action.buttons, up to 3 reply buttons (title up to 20 characters; the shortcut \"buttons\": [\"Confirm\", \"Change\"] works too). type list: action.button (the text that opens the list) and action.sections with rows (up to 10 rows in all; a row can be a plain title). type cta_url: action.parameters {display_text, url}. header: text (60 characters), or image / video / document (link, data or id) for button and cta_url. body.text up to 1024 characters, footer.text up to 60. Also (WhatsApp Cloud API's objects): carousel (action.cards: 2 to 10, image or video header, one URL button or quick replies each; or product cards {card_index, type: 'product', action: {product_retailer_id, catalog_id}}), location_request_message, request_contact_info, flow (action.parameters: flow_message_version '3', flow_id or flow_name, flow_cta), product and product_list (a connected catalog), catalog_message, call_permission_request and voice_call (Calling), address_message (India; optional text header), order_details and order_status (payments). The fixed action.name of a kind is filled in when left out.",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "button",
              "list",
              "cta_url",
              "carousel",
              "location_request_message",
              "request_contact_info",
              "flow",
              "product",
              "product_list",
              "catalog_message",
              "call_permission_request",
              "voice_call",
              "address_message",
              "order_details",
              "order_status"
            ]
          },
          "header": {
            "type": "object",
            "additionalProperties": true,
            "example": {
              "type": "text",
              "text": "Booking"
            }
          },
          "body": {
            "type": "object",
            "required": [
              "text"
            ],
            "properties": {
              "text": {
                "type": "string",
                "maxLength": 1024,
                "example": "Confirm your booking for Friday 10:00?"
              }
            }
          },
          "footer": {
            "type": "object",
            "properties": {
              "text": {
                "type": "string",
                "maxLength": 60
              }
            }
          },
          "action": {
            "type": "object",
            "additionalProperties": true,
            "example": {
              "buttons": [
                {
                  "type": "reply",
                  "reply": {
                    "id": "yes",
                    "title": "Confirm"
                  }
                },
                {
                  "type": "reply",
                  "reply": {
                    "id": "no",
                    "title": "Change"
                  }
                }
              ]
            }
          }
        }
      },
      "Language": {
        "type": "object",
        "required": [
          "code"
        ],
        "description": "Required when the template exists in more than one language.",
        "properties": {
          "code": {
            "type": "string",
            "example": "en",
            "description": "Template language code, eg 'en', 'en_US', 'nl'."
          }
        }
      },
      "Location": {
        "type": "object",
        "required": [
          "latitude",
          "longitude"
        ],
        "properties": {
          "latitude": {
            "type": "string",
            "example": "-33.8688"
          },
          "longitude": {
            "type": "string",
            "example": "151.2093"
          },
          "name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          }
        }
      },
      "LocationContent": {
        "type": "object",
        "required": [
          "latitude",
          "longitude"
        ],
        "properties": {
          "latitude": {
            "type": "number",
            "minimum": -90,
            "maximum": 90,
            "example": -33.8568
          },
          "longitude": {
            "type": "number",
            "minimum": -180,
            "maximum": 180,
            "example": 151.2153
          },
          "name": {
            "type": "string",
            "example": "Sydney Opera House"
          },
          "address": {
            "type": "string",
            "example": "Bennelong Point, Sydney NSW 2000"
          }
        }
      },
      "Media": {
        "type": "object",
        "description": "Give exactly one of: link, data or id. To send the template's own sample media instead, leave the header component out.",
        "properties": {
          "link": {
            "type": "string",
            "format": "uri",
            "example": "https://example.com/photo.jpg",
            "description": "Public http(s) URL. app2email downloads the file (no login, no private network addresses) and uploads it to WhatsApp."
          },
          "data": {
            "type": "string",
            "format": "byte",
            "description": "The file, base64 encoded. A 'data:<mime>;base64,' prefix is accepted."
          },
          "id": {
            "type": "string",
            "description": "A media id already uploaded to WhatsApp for this number."
          },
          "filename": {
            "type": "string",
            "example": "invoice.pdf",
            "description": "Shown to the recipient for documents. Also helps detect the file type."
          },
          "mime_type": {
            "type": "string",
            "example": "application/pdf",
            "description": "Optional. The type is detected from the file where possible."
          }
        }
      },
      "Parameter": {
        "type": "object",
        "required": [
          "type"
        ],
        "description": "One value. Set 'type' and the matching field, eg {\"type\":\"text\",\"text\":\"John\"} or {\"type\":\"image\",\"image\":{\"link\":\"https://...\"}}.",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "text",
              "image",
              "video",
              "document",
              "location",
              "currency",
              "date_time",
              "payload",
              "coupon_code",
              "action",
              "product",
              "limited_time_offer"
            ]
          },
          "parameter_name": {
            "type": "string",
            "description": "For templates with NAMED placeholders, eg 'first_name' for {{first_name}}."
          },
          "text": {
            "type": "string",
            "description": "type 'text'. No new lines, tabs or more than 4 spaces in a row."
          },
          "image": {
            "$ref": "#/components/schemas/Media"
          },
          "video": {
            "$ref": "#/components/schemas/Media"
          },
          "document": {
            "$ref": "#/components/schemas/Media"
          },
          "location": {
            "$ref": "#/components/schemas/Location"
          },
          "currency": {
            "$ref": "#/components/schemas/Currency"
          },
          "date_time": {
            "$ref": "#/components/schemas/DateTime"
          },
          "payload": {
            "type": "string",
            "description": "type 'payload': quick reply button payload."
          },
          "coupon_code": {
            "type": "string",
            "description": "type 'coupon_code': copy code button value."
          },
          "action": {
            "type": "object",
            "additionalProperties": true,
            "description": "type 'action': flow / catalog button data, as WhatsApp Cloud API."
          },
          "product": {
            "type": "object",
            "properties": {
              "product_retailer_id": {
                "type": "string"
              },
              "catalog_id": {
                "type": "string"
              }
            },
            "description": "type 'product': a product header."
          },
          "limited_time_offer": {
            "type": "object",
            "properties": {
              "expiration_time_ms": {
                "type": "integer",
                "example": 1767225600000
              }
            },
            "description": "type 'limited_time_offer': when the offer ends (ms since 1970)."
          }
        }
      },
      "ReactionContent": {
        "type": "object",
        "required": [
          "message_id",
          "emoji"
        ],
        "properties": {
          "message_id": {
            "type": "string",
            "example": "wamid.HBgLNjE0MTIzNDU2NzgVAgASGBQzQUZCMTY0MDc2MUYwNzBDNTY5MAA=",
            "description": "A message the contact sent, up to 30 days old."
          },
          "emoji": {
            "type": "string",
            "example": "👍",
            "description": "One emoji. \"\" removes your reaction."
          }
        }
      },
      "Recipient": {
        "type": "object",
        "required": [
          "to"
        ],
        "properties": {
          "to": {
            "type": "string",
            "example": "61412345678",
            "description": "One number, with country code."
          },
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Component"
            },
            "description": "Only what differs for this number, eg its body values. The rest comes from template.components."
          },
          "recipient_identity_key_hash": {
            "type": "string",
            "maxLength": 200,
            "description": "Optional: this contact's identity_key_hash (see the request's)."
          }
        }
      },
      "SendTemplateRequest": {
        "type": "object",
        "description": "A WhatsApp message in the format of WhatsApp Cloud API (Meta's exact body works unchanged): a template (type 'template', the default, any time), or within 24 hours of the contact's last message a free-form text, image, video, document, audio, sticker, location, contacts, reaction or interactive message. Meta's mark-read body {messaging_product, status: 'read', message_id, typing_indicator?} marks a message as read. Give 'to' or 'recipients' (templates only).",
        "properties": {
          "messaging_product": {
            "type": "string",
            "enum": [
              "whatsapp"
            ],
            "description": "Optional. Always 'whatsapp'."
          },
          "recipient_type": {
            "type": "string",
            "enum": [
              "individual"
            ],
            "description": "Optional. Always 'individual'."
          },
          "to": {
            "type": "string",
            "example": "61412345678",
            "description": "Recipient's WhatsApp number with country code. Digits only is best (spaces, '+', '-' are removed). Several recipients: separate the numbers with commas, eg \"61412345678,61498765432\" (semicolons and new lines work too), or send a JSON array of numbers. Each number gets its own message, and the response lists the result per number in 'results'. A free-form message (not 'template') goes to one number. A business-scoped user id (eg 61.AbC123, from from_user_id) is accepted as it is."
          },
          "recipient": {
            "type": "string",
            "example": "61.AbC123xyz",
            "description": "Optional, instead of 'to': one contact, a phone number or a business-scoped user id (BSUID). Sent to WhatsApp as 'recipient'."
          },
          "segment": {
            "type": "string",
            "example": "VIP, consented",
            "description": "Optional, app2email only, instead of 'to' / 'recipients': the id or name of a saved segment (GET /segments). Templates only. Each contact's named template parameters without a value are filled from its custom_fields ('name' from the contact's name). Recorded as a broadcast."
          },
          "type": {
            "type": "string",
            "enum": [
              "template",
              "text",
              "image",
              "video",
              "document",
              "interactive",
              "audio",
              "sticker",
              "location",
              "contacts",
              "reaction"
            ],
            "default": "template",
            "description": "'template' (default): an approved template. Otherwise a free-form message within the 24 hour window; the field of the same name holds it. Left out with status 'read': mark as read."
          },
          "interactive": {
            "$ref": "#/components/schemas/Interactive",
            "description": "type 'interactive': reply buttons, a list, or a URL button."
          },
          "template": {
            "$ref": "#/components/schemas/Template"
          },
          "text": {
            "$ref": "#/components/schemas/FreeFormText",
            "description": "type 'text': the message."
          },
          "image": {
            "$ref": "#/components/schemas/FreeFormMedia",
            "description": "type 'image': link, data+filename or id, and an optional caption."
          },
          "video": {
            "$ref": "#/components/schemas/FreeFormMedia",
            "description": "type 'video': link, data+filename or id, and an optional caption."
          },
          "document": {
            "$ref": "#/components/schemas/FreeFormMedia",
            "description": "type 'document': link, data+filename or id, and an optional caption."
          },
          "reply_to": {
            "type": "string",
            "example": "wamid.HBgLNjE0MTIzNDU2NzgVAgARGBJTQU1QTEVfVEVTVF9FVkVOVAA=",
            "description": "Optional, free-form only: the message_id of one of the contact's messages, quoted by this one. Meta's 'context': {\"message_id\": ...} works too."
          },
          "send_at": {
            "type": "string",
            "format": "date-time",
            "example": "2026-11-02T09:00:00+11:00",
            "description": "Optional, templates only: send later. ISO 8601 with a time zone ('Z' or '+11:00'), 1 minute to 29 days ahead. The answer is HTTP 202 with status 'scheduled'."
          },
          "campaign_name": {
            "type": "string",
            "maxLength": 100,
            "example": "October newsletter",
            "description": "Optional, app2email only. Several numbers in 'to' (or 'recipients'): the name of the broadcast this list is recorded as (Activity Log under Broadcasts). Default \"API: <template name>\". Not used for one number."
          },
          "recipients": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Recipient"
            },
            "description": "Optional, app2email only, instead of 'to': each number with its own values. Each entry's components replace the shared template.components of the same type (a button: the same index). Every number is checked before anything is sent."
          },
          "dry_run": {
            "type": "boolean",
            "default": false,
            "description": "Optional, app2email only. true: check everything and answer with the exact WhatsApp message per number, without sending, logging or counting anything."
          },
          "background": {
            "type": "boolean",
            "default": false,
            "description": "Optional, app2email only. true: answer HTTP 202 once everything is checked and the media uploaded, then send. Progress: broadcast.status_url (GET /v1/{number}/broadcasts/{code}) or the broadcast.completed webhook event."
          },
          "audio": {
            "$ref": "#/components/schemas/AudioContent",
            "description": "type 'audio'."
          },
          "sticker": {
            "$ref": "#/components/schemas/StickerContent",
            "description": "type 'sticker'."
          },
          "location": {
            "$ref": "#/components/schemas/LocationContent",
            "description": "type 'location'."
          },
          "contacts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactCard"
            },
            "description": "type 'contacts': 1 to 20 cards."
          },
          "reaction": {
            "$ref": "#/components/schemas/ReactionContent",
            "description": "type 'reaction'."
          },
          "context": {
            "type": "object",
            "properties": {
              "message_id": {
                "type": "string"
              }
            },
            "description": "Meta's form of reply_to."
          },
          "callback_data": {
            "type": "string",
            "maxLength": 512,
            "example": "order-1234",
            "description": "Optional. Sent to WhatsApp as biz_opaque_callback_data; back as data.callback_data in this message's message.status events. Meta's own field name works too."
          },
          "recipient_identity_key_hash": {
            "type": "string",
            "maxLength": 200,
            "example": "DF2lS5v2W6x=",
            "description": "Optional, one recipient (per number: in recipients[]): delivered only while the contact's identity key has this hash (message.received data.identity_key_hash); else message.failed, 137000 recipient_identity_changed. Needs PUT /settings/identity-check."
          },
          "marketing_api": {
            "type": "string",
            "enum": [
              "auto",
              "cloud_api",
              "mm_api"
            ],
            "description": "Optional, MARKETING templates: the path for this send (true = mm_api, false = cloud_api). Default: the number's setting messages.marketing_route (auto)."
          },
          "product_policy": {
            "type": "string",
            "enum": [
              "CLOUD_API_FALLBACK",
              "STRICT"
            ],
            "description": "Optional, Marketing Messages API only: STRICT = no fallback to the Cloud API. Default CLOUD_API_FALLBACK."
          },
          "message_activity_sharing": {
            "type": "boolean",
            "description": "Optional, Marketing Messages API only: share read and click activity with Meta for this message."
          },
          "status": {
            "type": "string",
            "enum": [
              "read"
            ],
            "description": "Meta's mark-read body: 'read' with message_id (no type)."
          },
          "message_id": {
            "type": "string",
            "description": "Meta's mark-read body: the received message."
          },
          "typing_indicator": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "text"
                ]
              }
            },
            "description": "Meta's mark-read body: also show the typing indicator."
          }
        }
      },
      "StickerContent": {
        "type": "object",
        "description": "WebP only: up to 100 KB static, 500 KB animated. No caption.",
        "properties": {
          "link": {
            "type": "string",
            "format": "uri",
            "description": "Public http(s) URL. app2email downloads the file and uploads it to WhatsApp."
          },
          "data": {
            "type": "string",
            "format": "byte",
            "description": "The file, base64 encoded."
          },
          "id": {
            "type": "string",
            "description": "A media id from POST /media."
          },
          "filename": {
            "type": "string"
          },
          "mime_type": {
            "type": "string"
          }
        }
      },
      "SubmitFieldInfo": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "textarea",
              "number",
              "email",
              "phone",
              "date",
              "select",
              "multiselect",
              "yesno",
              "rating",
              "consent",
              "photo",
              "document",
              "location",
              "info",
              "hidden"
            ]
          },
          "step": {
            "type": "string",
            "description": "The key of its step. Empty for a calculated field."
          },
          "internal": {
            "type": "boolean",
            "description": "true: its value is in extra, not in answers."
          },
          "unit": {
            "type": "string"
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "maxLength": 40,
                  "example": "gas",
                  "description": "What is stored as the answer. Unique in the field."
                },
                "title": {
                  "type": "string",
                  "maxLength": 80,
                  "example": "Gas",
                  "description": "What people see (WhatsApp shows the first 30 characters)."
                },
                "description": {
                  "type": "string",
                  "maxLength": 300,
                  "description": "A second line, optional."
                }
              },
              "required": [
                "id",
                "title"
              ]
            },
            "description": "select and multiselect."
          },
          "calculated": {
            "type": "boolean",
            "description": "true: worked out by a formula."
          }
        },
        "description": "One field of a form, as a column: the key to read in answers or extra, and how to label it."
      },
      "SubmitForm": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 7
          },
          "key": {
            "type": "string",
            "example": "meter_reading",
            "description": "The form's name in the API and in its web address."
          },
          "name": {
            "type": "string",
            "example": "Meter reading"
          },
          "enabled": {
            "type": "boolean",
            "description": "false: its words and links answer nothing new; its submissions stay."
          },
          "archived": {
            "type": "boolean",
            "description": "true: hidden from the lists, takes no submissions."
          },
          "position": {
            "type": "integer"
          },
          "definition": {
            "$ref": "#/components/schemas/SubmitFormDefinition",
            "description": "The working copy. One form only."
          },
          "published": {
            "type": "object",
            "nullable": true,
            "description": "The version live on WhatsApp, or null when it was never published.",
            "properties": {
              "hash": {
                "type": "string",
                "example": "3f9a1c0b7d2e"
              },
              "published_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          },
          "changed": {
            "type": "boolean",
            "description": "true: the working copy differs from the published version: publish to make it live on WhatsApp. false also while the form was never published (published is null then)."
          },
          "flow": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Meta's id of the WhatsApp Flow. Empty until published."
              },
              "status": {
                "type": "string",
                "enum": [
                  "",
                  "DRAFT",
                  "PUBLISHED",
                  "DEPRECATED",
                  "BLOCKED",
                  "THROTTLED"
                ],
                "description": "Meta's status. Only PUBLISHED is sent to customers."
              },
              "validation_errors": {
                "type": "array",
                "items": {},
                "description": "Meta's complaints about the generated form, when there are any."
              },
              "checked_at": {
                "type": "string",
                "description": "When the status was last read from Meta. Empty: never."
              },
              "last_error": {
                "type": "string",
                "description": "Why the last publish failed. Empty when it worked."
              },
              "can_send": {
                "type": "boolean",
                "description": "true: the form can be sent inside WhatsApp now. false: its words and the send route answer with the web link."
              }
            },
            "description": "The form's state on WhatsApp."
          },
          "links": {
            "type": "object",
            "properties": {
              "web": {
                "type": "string",
                "description": "The web page of the form."
              },
              "wa_me": {
                "type": "string",
                "description": "Opens the WhatsApp chat with the form's first word typed in. Put it behind a link or a QR code."
              },
              "words": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "description": "How people reach the form."
          },
          "counts": {
            "type": "object",
            "properties": {
              "open": {
                "type": "integer"
              },
              "total": {
                "type": "integer"
              }
            },
            "description": "Its submissions."
          },
          "fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubmitFieldInfo"
            },
            "description": "Every field and calculated value as a column. One form only."
          },
          "created": {
            "type": "string",
            "format": "date-time"
          },
          "updated": {
            "type": "string",
            "format": "date-time"
          }
        },
        "description": "A form. GET /submit/forms lists forms without definition and fields; GET /submit/forms/{key} has both."
      },
      "SubmitFormCreateRequest": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "example": "meter_reading",
            "description": "The form's key: lower case letters, digits and _, starting with a letter, at most 40 characters (check is reserved). Left out: made from the name. It is part of the web address and cannot be changed later."
          },
          "name": {
            "type": "string",
            "example": "Meter reading",
            "description": "The name in the dashboard and the inbox. Needed with definition."
          },
          "definition": {
            "$ref": "#/components/schemas/SubmitFormDefinition"
          },
          "preset": {
            "type": "string",
            "example": "quote",
            "description": "Instead of a definition: install this preset (GET /submit/presets): its form together with the lists and automations that belong to it. key and name, when given, rename its form."
          }
        },
        "description": "name and definition, or preset."
      },
      "SubmitFormDefinition": {
        "type": "object",
        "required": [
          "title",
          "steps"
        ],
        "properties": {
          "title": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60,
            "example": "Meter reading",
            "description": "The form's public name, 1 to 60 characters."
          },
          "description": {
            "type": "string",
            "maxLength": 300,
            "description": "Under the title on the web page and in the forms menu, up to 300 characters."
          },
          "prefix": {
            "type": "string",
            "example": "MR",
            "description": "2 to 4 letters A-Z that start every reference of this form (MR-7Q3M2A). \"\" = the settings' default_prefix."
          },
          "steps": {
            "type": "array",
            "minItems": 1,
            "maxItems": 12,
            "items": {
              "$ref": "#/components/schemas/SubmitFormStep"
            },
            "description": "1 to 12 steps, in the order they are asked. One step is one screen; app2email splits a step over several screens by itself when WhatsApp's limits demand it."
          },
          "stages": {
            "type": "array",
            "minItems": 2,
            "maxItems": 12,
            "items": {
              "$ref": "#/components/schemas/SubmitFormStage"
            },
            "description": "2 to 12 stages a submission moves through. The first one is where a new submission starts. At least one of kind open and one of kind done. Left out: New (open), In progress (open), Done (done)."
          },
          "who": {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "anyone",
                  "listed"
                ],
                "default": "anyone",
                "description": "listed: only the numbers below, or contacts with the tag, may submit (a form for field staff). listed needs at least one number or a tag."
              },
              "numbers": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Up to 500 numbers, digits only with country code (6 to 20 digits)."
              },
              "tag": {
                "type": "string",
                "maxLength": 40,
                "description": "A contact tag: contacts carrying it may submit."
              }
            },
            "description": "Who may submit."
          },
          "trigger": {
            "type": "object",
            "properties": {
              "words": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "example": [
                  "meter"
                ],
                "description": "A contact who sends one of these words gets the form. Up to 10 words, 30 characters each. A word that another form of the number or an enabled Book-and-Pay word already uses is refused (word_taken)."
              },
              "header": {
                "type": "string",
                "maxLength": 60,
                "description": "A bold line above the body, optional."
              },
              "body": {
                "type": "string",
                "maxLength": 1000,
                "example": "Tap the button to send your reading.",
                "description": "The text of the message that carries the form, 1 to 1,000 characters. Left out: Tap the button to open the form."
              },
              "button": {
                "type": "string",
                "maxLength": 20,
                "example": "Open form",
                "description": "The button's text, 1 to 20 characters. Left out: Open form."
              },
              "footer": {
                "type": "string",
                "maxLength": 60,
                "description": "A small grey line, optional."
              }
            },
            "description": "The message that opens the form on WhatsApp, and the words that send it."
          },
          "after": {
            "type": "object",
            "properties": {
              "review_step": {
                "type": "boolean",
                "default": true,
                "description": "A last screen that lists the answers before sending."
              },
              "reply": {
                "type": "string",
                "maxLength": 1000,
                "description": "The WhatsApp message after sending, with placeholders ({reference}, {form}, {contact.name} ...). \"\" = no reply. Left out: a thank-you with the reference."
              },
              "allow_additions": {
                "type": "boolean",
                "default": false,
                "description": "The reply gets an Add more button: text, photos and files the submitter sends in the next 10 minutes are attached to the submission."
              },
              "status_page": {
                "type": "boolean",
                "default": true,
                "description": "The reply carries a button to the submitter's status page."
              }
            },
            "description": "What happens right after a submission."
          },
          "web": {
            "type": "object",
            "properties": {
              "enabled": {
                "type": "boolean",
                "default": true,
                "description": "The form has a web page (links.web of the form)."
              },
              "verify": {
                "type": "string",
                "enum": [
                  "off",
                  "optional",
                  "required"
                ],
                "default": "optional",
                "description": "Proving the WhatsApp number of a web submission with one message. optional: offered as Get updates on WhatsApp. required: the submission counts only once proven. off: never asked."
              },
              "ask_email": {
                "type": "boolean",
                "default": false,
                "description": "Also ask for an e-mail address at the end."
              },
              "success_text": {
                "type": "string",
                "maxLength": 500,
                "description": "Shown after sending. \"\" = the standard text."
              }
            },
            "description": "The web page of the form."
          },
          "notify": {
            "type": "object",
            "properties": {
              "email": {
                "type": "boolean",
                "default": true,
                "description": "E-mail the business for each submission (to the settings' notify_email)."
              },
              "to": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 5,
                "description": "Up to 5 more addresses."
              },
              "attach_files": {
                "type": "boolean",
                "default": true,
                "description": "Attach the submission's files."
              }
            },
            "description": "The e-mail the business gets."
          },
          "calculated": {
            "type": "array",
            "maxItems": 20,
            "description": "0 to 20 calculated fields: values worked out from the answers each time they change, stored in extra. Formulas (calculated fields, the calculate action, and {= ... } inside any text): numbers, 'texts' in single quotes, field keys, + - * / %, the comparisons == != > >= < <=, and / or / not, brackets, and the functions if(condition, then, else): then when the condition holds, otherwise else (null without an else). min(a, b, ...): The smallest number. max(a, b, ...): The largest number. round(x, decimals): x rounded, half away from zero; decimals 0 to 10, default 0. abs(x): x without its sign. num(x): x as a number, null when it is not one. len(x): The length of a text, or the number of items of a list. coalesce(a, b, ...): The first value that is not empty. lower(x): x in lower case. upper(x): x in upper case. concat(a, b, ...): The values joined as one text. lookup('<list>', id, '<column>'): A column of the item with that id in a list of the number, for example a price. previous('<field>'): The same contact's last value of that field in this form. count_files('<field>'): How many files a photo or document field holds. days_since(date): Whole days from a date (YYYY-MM-DD) to today; negative for a date to come. No loops and no assignment; at most 500 characters; a division by zero or a missing number gives null. Examples: reading - previous('reading'); quantity * lookup('products', product, 'price'); if(usage < 0, 'check', 'ok'); round(amount * 1.2, 2); days_since(purchase_date) > 30 and count_files('receipt') == 0.",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string",
                  "example": "usage",
                  "description": "Its name in extra, rules and placeholders. Same rules as a field key."
                },
                "label": {
                  "type": "string",
                  "maxLength": 60,
                  "example": "Usage"
                },
                "formula": {
                  "type": "string",
                  "maxLength": 500,
                  "example": "reading - previous('reading')"
                },
                "unit": {
                  "type": "string"
                },
                "decimals": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 6
                }
              },
              "required": [
                "key",
                "formula"
              ]
            }
          },
          "retention_days": {
            "type": "integer",
            "default": 0,
            "description": "0 = keep. Otherwise closed submissions and their files are erased this many days after closing (30 to 3650)."
          }
        },
        "example": {
          "title": "Meter reading",
          "description": "Send us this month's reading.",
          "prefix": "MR",
          "steps": [
            {
              "key": "reading",
              "title": "Your reading",
              "text": "",
              "show_if": null,
              "fields": [
                {
                  "key": "meter_no",
                  "type": "text",
                  "label": "Meter number",
                  "help": "On the front of the meter",
                  "required": true,
                  "default": "{contact.meter_no}",
                  "max_length": 20
                },
                {
                  "key": "reading",
                  "type": "number",
                  "label": "Meter reading",
                  "required": true,
                  "min": 0,
                  "max": 999999,
                  "decimals": 0,
                  "unit": "kWh"
                },
                {
                  "key": "photo",
                  "type": "photo",
                  "label": "Photo of the meter",
                  "required": true,
                  "max_files": 1,
                  "source": "camera"
                },
                {
                  "key": "moving",
                  "type": "yesno",
                  "label": "Are you moving out?",
                  "required": true
                },
                {
                  "key": "billing_ref",
                  "type": "text",
                  "label": "Billing reference",
                  "internal": true
                }
              ]
            },
            {
              "key": "move",
              "title": "Your move",
              "text": "We will close the account on that day.",
              "show_if": {
                "field": "moving",
                "equals": true
              },
              "fields": [
                {
                  "key": "move_date",
                  "type": "date",
                  "label": "Moving date",
                  "required": true,
                  "min_days": -30,
                  "max_days": 90
                },
                {
                  "key": "new_address",
                  "type": "textarea",
                  "label": "New address for the final bill",
                  "required": false,
                  "max_length": 300
                }
              ]
            }
          ],
          "stages": [
            {
              "key": "received",
              "name": "Received",
              "kind": "open",
              "color": "blue",
              "set_by": [],
              "require_note": false,
              "message": ""
            },
            {
              "key": "queried",
              "name": "Queried",
              "kind": "open",
              "color": "amber",
              "set_by": [],
              "require_note": true,
              "message": "We have a question about your reading {reference}: {note}"
            },
            {
              "key": "checked",
              "name": "Checked",
              "kind": "done",
              "color": "green",
              "set_by": [
                "manager"
              ],
              "require_note": false,
              "message": "Thanks {contact.name}, your reading of {reading} kWh is recorded."
            }
          ],
          "who": {
            "mode": "anyone",
            "numbers": [],
            "tag": ""
          },
          "trigger": {
            "words": [
              "meter",
              "reading"
            ],
            "header": "",
            "body": "Tap the button to send your reading.",
            "button": "Open form",
            "footer": ""
          },
          "after": {
            "review_step": true,
            "reply": "Thanks {contact.name}. We have your {form} - reference {reference}.",
            "allow_additions": false,
            "status_page": true
          },
          "web": {
            "enabled": true,
            "verify": "optional",
            "ask_email": false,
            "success_text": ""
          },
          "notify": {
            "email": true,
            "to": [],
            "attach_files": true
          },
          "calculated": [
            {
              "key": "usage",
              "label": "Usage",
              "formula": "reading - previous('reading')",
              "unit": "kWh",
              "decimals": 0
            }
          ],
          "retention_days": 0
        },
        "description": "A form as one document. The same JSON drives the WhatsApp form (app2email generates it: there is nothing to draw), the web page, the checks on every answer, the inbox columns and the exports. `steps` hold the fields; `stages` are the states a submission moves through; `who`, `trigger`, `after`, `web`, `notify`, `calculated` and `retention_days` are optional and take their defaults when left out. Limits: 12 steps, 12 fields in a step, 60 fields in a form, one location field, 64 KB of JSON. A save is checked as a whole: with any problem nothing is saved and the 400 answer lists each one with its path and a fix. The saved form comes back normalized, with every default filled in. Saving changes the working copy; WhatsApp keeps showing the published version until POST /submit/forms/{key}/publish is called again. Conditions: a step or a field with `show_if` appears only when its rule holds, and the rule may only look at fields of earlier steps. A rule is {\"field\": \"<key>\", <operator>: <value>} with the operators equals, not_equals, in, not_in, contains, empty, not_empty, gt, gte, lt, lte. Every operator written in one rule must hold. When the field's value is an array (multiselect, tags) a rule holds when any item matches, except not_equals and not_in, which need every item. Rules combine as {\"all\": [rule, ...]} (every one) or {\"any\": [rule, ...]} (at least one); groups nest 2 deep with up to 10 rules each. null = no condition. Examples: {\"field\": \"deliver\", \"equals\": true}; {\"all\": [{\"field\": \"amount\", \"gt\": 5000}, {\"field\": \"category\", \"in\": [\"plant\", \"vehicle\"]}]}."
      },
      "SubmitFormField": {
        "type": "object",
        "required": [
          "key",
          "type",
          "label"
        ],
        "properties": {
          "key": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,39}$",
            "example": "reading",
            "description": "The field's name in answers, rules, placeholders, formulas and exports: a lower case letter, then lower case letters, digits or _ (at most 40 characters). Unique in the form, not a reserved word, not starting with _. Reserved: reference, status, status_name, form, form_key, channel, contact, link, id, created, updated, assignee, priority, tags, due, files, flow_token, screen, error_message, error, answers, extra, submission, note, button, business, desk_link, status_kind, verified, files_count, prefill, confirm, true, false, null, and, or, not."
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "textarea",
              "number",
              "email",
              "phone",
              "date",
              "select",
              "multiselect",
              "yesno",
              "rating",
              "consent",
              "photo",
              "document",
              "location",
              "info",
              "hidden"
            ],
            "description": "The field type decides the answer's JSON type, the keys that apply and how WhatsApp shows it. `text` (value: string; on WhatsApp: text input): min_length, max_length, pattern. `textarea` (value: string; on WhatsApp: text area): min_length, max_length, pattern. `number` (value: number; on WhatsApp: number input): min, max, decimals, unit. `email` (value: string; on WhatsApp: e-mail input). `phone` (value: string; on WhatsApp: phone input). 6 to 20 digits. `date` (value: string, YYYY-MM-DD; on WhatsApp: date picker): min_days, max_days. `select` (value: string: the id of the choice; on WhatsApp: radio buttons up to 8 choices, a dropdown above that): choices, list. While its list is empty a select is not required and not checked. `multiselect` (value: array of strings: the ids of the choices; on WhatsApp: checkboxes): choices, min_choices, max_choices. `yesno` (value: boolean; on WhatsApp: Yes / No radio buttons). `rating` (value: number, 1 to max; on WhatsApp: radio buttons 1 to max): max. `consent` (value: boolean; on WhatsApp: a tick box). The label is the sentence to agree to (at most 120 characters). required true = it must be ticked. `photo` (value: array of file ids; on WhatsApp: photo picker): max_files, source. WhatsApp allows one photo or document picker on a screen: a step with several is split into several screens by itself. `document` (value: array of file ids; on WhatsApp: document picker): max_files, kinds. One picker on a screen, as for photo. `location` (value: string: the address text; the pin is the submission's location {lat, lng, name, address}; on WhatsApp: asked after the form with WhatsApp's own Send location request). On the web page: a Use my location button and an address line. One location field in a form; required is not enforced for it. `info` (value: nothing is stored; on WhatsApp: a heading (the label) and text): text. `hidden` (value: string; on WhatsApp: nothing is shown). The value is the field's default (usually {prefill.<key>}), or the prefill value given under the field's own key: a job number or an account that arrives with the link or the send call."
          },
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "example": "Meter reading",
            "description": "The question, 1 to 200 characters. A label longer than WhatsApp allows on the input is moved into text above it by itself."
          },
          "help": {
            "type": "string",
            "maxLength": 80,
            "description": "A hint with the input, up to 80 characters."
          },
          "required": {
            "type": "boolean",
            "description": "true: must be answered (consent: must be ticked). Default false. Not enforced for a location field: the pin arrives after the form."
          },
          "internal": {
            "type": "boolean",
            "default": false,
            "description": "true: never asked. Staff, the API or an automation fill it (a quote amount, a decision reason, an id another system returned). Its value is stored in the submission's extra and shows in the inbox and in exports. Only for the types text, textarea, number, email, phone, date, select, multiselect, yesno and rating; an internal field is never required and has no show_if. Default false."
          },
          "show_if": {
            "$ref": "#/components/schemas/SubmitRule",
            "nullable": true,
            "description": "A rule on fields of EARLIER steps: the field is asked only when the rule holds. The rule may look at fields that are asked or hidden, not at internal or info fields. A field that is not shown counts as empty for the rules after it. null = always."
          },
          "default": {
            "type": "string",
            "description": "The starting value, up to 500 characters: a literal, or the placeholders {contact.name}, {contact.phone}, {contact.<custom field>}, {prefill.<key>} (prefill = the values given when the form is sent). Not for photo, document, location and info."
          },
          "sensitive": {
            "type": "boolean",
            "default": false,
            "description": "true: the value is masked in WhatsApp's own summary of the form. Only for the types text, textarea, number, email, phone, date, select, multiselect, yesno and rating. Default false."
          },
          "min_length": {
            "type": "integer",
            "minimum": 0,
            "description": "text, textarea. Fewest characters. 0 = none."
          },
          "max_length": {
            "type": "integer",
            "minimum": 0,
            "description": "text, textarea. Most characters. 0 = the type's limit (text 200, textarea 2,000)."
          },
          "pattern": {
            "type": "string",
            "maxLength": 200,
            "description": "text, textarea. A regular expression the whole answer must match, up to 200 characters."
          },
          "min": {
            "type": "number",
            "nullable": true,
            "description": "number. Smallest value. null = none."
          },
          "max": {
            "type": "number",
            "nullable": true,
            "description": "number: the largest value, null = none. rating: the highest rating, 3 to 10, default 5."
          },
          "decimals": {
            "type": "integer",
            "minimum": 0,
            "maximum": 6,
            "default": 0,
            "description": "number. Decimal places allowed, 0 to 6. Default 0."
          },
          "unit": {
            "type": "string",
            "example": "kWh",
            "description": "number. Shown after the value, for example kWh. Up to 20 characters."
          },
          "min_days": {
            "type": "integer",
            "nullable": true,
            "description": "date. Earliest day, counted from today (negative = in the past). null = none."
          },
          "max_days": {
            "type": "integer",
            "nullable": true,
            "description": "date. Latest day, counted from today. null = none."
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "maxLength": 40,
                  "example": "gas",
                  "description": "What is stored as the answer. Unique in the field."
                },
                "title": {
                  "type": "string",
                  "maxLength": 80,
                  "example": "Gas",
                  "description": "What people see (WhatsApp shows the first 30 characters)."
                },
                "description": {
                  "type": "string",
                  "maxLength": 300,
                  "description": "A second line, optional."
                }
              },
              "required": [
                "id",
                "title"
              ]
            },
            "description": "select: 2 to 200 choices (or use list). multiselect: 2 to 20 choices."
          },
          "list": {
            "type": "string",
            "example": "products",
            "description": "select. Instead of choices: the key of a list of the number (GET /submit/lists). The list is read each time the form opens, so changing it needs no publish. At most 200 items are shown."
          },
          "min_choices": {
            "type": "integer",
            "minimum": 0,
            "default": 0,
            "description": "multiselect. Fewest ticks. 0 = none."
          },
          "max_choices": {
            "type": "integer",
            "minimum": 0,
            "default": 0,
            "description": "multiselect. Most ticks. 0 = no limit."
          },
          "max_files": {
            "type": "integer",
            "minimum": 1,
            "maximum": 10,
            "default": 1,
            "description": "photo, document. How many files, 1 to 10."
          },
          "source": {
            "type": "string",
            "enum": [
              "any",
              "camera",
              "gallery"
            ],
            "default": "any",
            "description": "photo. Where the photo may come from."
          },
          "kinds": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "any",
                "pdf",
                "image",
                "office"
              ]
            },
            "description": "document. What may be sent: [\"any\"] (default), or some of pdf, image, office."
          },
          "text": {
            "type": "string",
            "maxLength": 1000,
            "description": "info. The text shown, up to 1,000 characters."
          }
        },
        "description": "One question, or one value that is carried along. Every type takes key, type, label, help, required, internal, show_if, default and sensitive; the other keys belong to one or two types and a key that does not apply is dropped when the form is saved.",
        "example": {
          "key": "reading",
          "type": "number",
          "label": "Meter reading",
          "required": true,
          "min": 0,
          "max": 999999,
          "decimals": 0,
          "unit": "kWh"
        }
      },
      "SubmitFormResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "request_id": {
            "type": "string"
          },
          "form": {
            "$ref": "#/components/schemas/SubmitForm"
          },
          "applied": {
            "type": "object",
            "additionalProperties": true,
            "description": "After POST /submit/forms with preset only: what the preset installed, as in the setup answer (lists, connections, forms, automations, published)."
          },
          "note": {
            "type": "string"
          }
        }
      },
      "SubmitFormStage": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,39}$",
            "example": "received",
            "description": "The stage's name in the API (the submission's status): a lower case letter, then lower case letters, digits or _ (at most 40 characters). Unique in the form."
          },
          "name": {
            "type": "string",
            "example": "Received",
            "description": "What people see, for example In review. Up to 40 characters."
          },
          "kind": {
            "type": "string",
            "enum": [
              "open",
              "done",
              "cancelled"
            ],
            "description": "open: still being worked on. done: finished well. cancelled: finished without a result. A form needs at least one open and one done stage."
          },
          "color": {
            "type": "string",
            "enum": [
              "grey",
              "blue",
              "green",
              "amber",
              "red",
              "purple"
            ],
            "description": "grey, blue, green, amber, red or purple."
          },
          "set_by": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "owner",
                "admin",
                "manager",
                "agent",
                "viewer"
              ]
            },
            "description": "The roles that may choose this stage: some of owner, admin, manager, agent, viewer. [] = anyone who may change stages. Owners, admins, automations and API keys always may."
          },
          "require_note": {
            "type": "boolean",
            "description": "true: a note must come with the move to this stage."
          },
          "message": {
            "type": "string",
            "maxLength": 1000,
            "description": "Sent to the submitter when the submission arrives in this stage, up to 1,000 characters, with placeholders ({note} = the note of the change). \"\" = nothing is sent."
          }
        },
        "required": [
          "key",
          "name",
          "kind"
        ],
        "description": "A stage of a form. Inside a submission the stages come without message."
      },
      "SubmitFormStep": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,39}$",
            "example": "reading",
            "description": "The step's name: a lower case letter, then lower case letters, digits or _ (at most 40 characters). Unique among the steps."
          },
          "title": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60,
            "example": "Your reading",
            "description": "The screen's title, 1 to 60 characters (WhatsApp shows the first 30)."
          },
          "text": {
            "type": "string",
            "maxLength": 500,
            "description": "Shown above the fields, up to 500 characters."
          },
          "show_if": {
            "$ref": "#/components/schemas/SubmitRule",
            "nullable": true,
            "description": "A rule on fields of EARLIER steps: the step is skipped when it does not hold. null = always."
          },
          "fields": {
            "type": "array",
            "minItems": 1,
            "maxItems": 12,
            "items": {
              "$ref": "#/components/schemas/SubmitFormField"
            },
            "description": "1 to 12 fields. Internal and hidden fields count but show nothing."
          }
        },
        "required": [
          "key",
          "title",
          "fields"
        ],
        "description": "One step of a form: a title and its fields."
      },
      "SubmitRule": {
        "type": "object",
        "additionalProperties": true,
        "description": "A rule is {\"field\": \"<key>\", <operator>: <value>} with the operators equals, not_equals, in, not_in, contains, empty, not_empty, gt, gte, lt, lte. Every operator written in one rule must hold. When the field's value is an array (multiselect, tags) a rule holds when any item matches, except not_equals and not_in, which need every item. Rules combine as {\"all\": [rule, ...]} (every one) or {\"any\": [rule, ...]} (at least one); groups nest 2 deep with up to 10 rules each. null = no condition. Examples: {\"field\": \"deliver\", \"equals\": true}; {\"all\": [{\"field\": \"amount\", \"gt\": 5000}, {\"field\": \"category\", \"in\": [\"plant\", \"vehicle\"]}]}. In a form (show_if) the field must belong to an EARLIER step. `equals`: The value is this. `not_equals`: The value is not this. `in`: The value is one of these (an array). `not_in`: The value is none of these (an array). `contains`: The text contains this (case does not matter), or the array has this item. `empty`: true: there is no value. `not_empty`: true: there is a value. `gt`: Greater than (numbers, dates). `gte`: Greater than or equal. `lt`: Less than. `lte`: Less than or equal.",
        "properties": {
          "field": {
            "type": "string",
            "example": "amount",
            "description": "A field key (or an extra key). Automations may also name status, status_kind, channel, form, priority, tags, assignee, verified, files_count, contact.name, contact.phone."
          },
          "equals": {},
          "not_equals": {},
          "in": {
            "type": "array",
            "items": {}
          },
          "not_in": {
            "type": "array",
            "items": {}
          },
          "contains": {},
          "empty": {
            "type": "boolean"
          },
          "not_empty": {
            "type": "boolean"
          },
          "gt": {},
          "gte": {},
          "lt": {},
          "lte": {},
          "all": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            },
            "description": "A group: every rule in it must hold."
          },
          "any": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            },
            "description": "A group: at least one rule in it must hold."
          }
        },
        "example": {
          "all": [
            {
              "field": "amount",
              "gt": 5000
            },
            {
              "field": "category",
              "in": [
                "plant",
                "vehicle"
              ]
            }
          ]
        }
      },
      "Template": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "order_update",
            "description": "Exact name of an APPROVED template."
          },
          "language": {
            "$ref": "#/components/schemas/Language"
          },
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Component"
            },
            "description": "Values for the template's placeholders and media. Leave out for templates without parameters."
          }
        }
      },
      "WhatsAppError": {
        "type": "object",
        "description": "WhatsApp's (Meta's) own error, when the error came from WhatsApp.",
        "properties": {
          "code": {
            "type": "integer",
            "example": 132000
          },
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "fbtrace_id": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Authorization: Bearer <your API key>"
      }
    }
  }
}
```

