{
  "openapi": "3.1.0",
  "info": {
    "title": "DoveMesh WhatsApp API",
    "version": "v3",
    "summary": "Send and receive WhatsApp messages, and manage templates, media, catalogs and more.",
    "contact": {
      "name": "DoveMesh support",
      "email": "contact@dovemesh.com"
    },
    "description": "Send and receive WhatsApp messages, and manage templates, media, catalogs, payments, QR codes and Flows. Guides and full reference: https://www.dovemesh.com/docs/whatsapp\n"
  },
  "servers": [
    {
      "url": "https://wa.dovemesh.com/v3"
    }
  ],
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "name": "Messages",
      "description": "Messages are what you send to your customers. Every kind of message uses one endpoint, [Send a message](/docs/whatsapp/messages/send-message). The `type` field says what you're sending, and a field with the same name holds the content:\n\n```json\n{\n  \"messaging_product\": \"whatsapp\",\n  \"to\": \"919876543210\",\n  \"type\": \"text\",\n  \"text\": { \"body\": \"Hello!\" }\n}\n```\n\n### What you can send\n\n- **`text`**: plain text, with optional link previews and WhatsApp formatting (`*bold*`, `_italic_`, `~strike~`).\n- **`image`, `video`, `audio`, `document`, `sticker`**: a file, sent by public link or by the ID of a file you [uploaded](/docs/whatsapp/media).\n- **`location`**: a map pin.\n- **`contacts`**: contact cards the customer can save.\n- **`interactive`**: messages the customer answers by tapping:\n  - **Reply buttons**: up to 3 buttons.\n  - **List**: a menu of up to 10 choices.\n  - **Link button**: opens a web page.\n  - **Location request**: asks the customer to share their location.\n  - **Address request**: a delivery address form (India and Singapore).\n  - **Product** and **product list**: items from your [catalog](/docs/whatsapp/catalog).\n  - **Carousel**: up to 10 swipeable cards.\n  - **Order details** and **order status**: payment requests and order updates ([Payments](/docs/whatsapp/payments), India only).\n- **`reaction`**: an emoji reaction to one of the customer's messages.\n- **`template`**: a message format approved in advance by WhatsApp. It's the only type you can send outside the [24-hour window](/docs/whatsapp/messaging-window). See [Templates](/docs/whatsapp/templates).\n\n### Replies and read receipts\n\n- **Quote a message.** Add `\"context\": { \"message_id\": \"wamid.…\" }` to show your message as a reply to an earlier one.\n- **Show blue ticks.** Send `\"status\": \"read\"` with an incoming `message_id`. The customer then sees that you've read their message.\n\n### After you send\n\nA successful response returns the message ID. It means WhatsApp **accepted** the message, not that it was delivered. Progress (`sent`, `delivered`, `read` or `failed`) arrives on your [webhook](/docs/whatsapp/webhooks) as a [message status](/docs/whatsapp/events/message-status) event.\n"
    },
    {
      "name": "Media",
      "description": "Media files are images, videos, audio, documents and stickers. You work with them in two directions.\n\n### Sending a file\n\nThere are two ways to attach a file to a message:\n\n- **By link.** Put a public HTTPS URL in `link`. WhatsApp downloads the file when it sends the message, so the URL must work without a login. This is the simplest option.\n- **By upload.** [Upload the file](/docs/whatsapp/media/upload-media) first, then send its `id`. This is better when you send the same file many times, or when it isn't public. Uploaded files are kept for 30 days.\n\n**Supported files**\n\n| Type | Formats | Max size |\n|---|---|---|\n| Image | JPEG, PNG | 5 MB |\n| Video | MP4, 3GPP (H.264 video, AAC audio) | 16 MB |\n| Audio | AAC, AMR, MP3, M4A, OGG (Opus) | 16 MB |\n| Document | PDF, Word, Excel, PowerPoint, plain text | 100 MB |\n| Sticker | WebP, 512×512 | 100 KB (500 KB animated) |\n\n### Receiving a file\n\nWhen a customer sends a file, your webhook receives an [incoming message](/docs/whatsapp/events/incoming-message) with a media `id`, not the file itself. To get the file, do one of these:\n\n- **One step:** call [Download media](/docs/whatsapp/media/download-media) with the ID. The response is the file.\n- **Two steps:** call [Retrieve a media URL](/docs/whatsapp/media/retrieve-media-url), then fetch that `url` with your `apikey` header. The URL expires after 5 minutes, so fetch it straight away.\n\nDownload received files promptly and store them yourself. WhatsApp deletes them after a while.\n"
    },
    {
      "name": "Templates",
      "description": "A template is a message format that WhatsApp reviews and approves before you can use it. Templates are the only messages you can send outside the [24-hour window](/docs/whatsapp/messaging-window), so you need them to start conversations, send notifications and send one-time passwords.\n\n### How it works\n\n1. **Create** the template with [Create a template](/docs/whatsapp/templates/create-template). It's usually `PENDING`, but WhatsApp can approve or reject it straight away, so check `status` in the response. Authentication templates are often `APPROVED` at once.\n2. **Wait for review**, if it's `PENDING`. WhatsApp usually decides within minutes, and sometimes takes up to 24 hours. The result arrives on your webhook as a [template status](/docs/whatsapp/events/template-status) event (`APPROVED` or `REJECTED`, with a reason). You can also [retrieve the template](/docs/whatsapp/templates/retrieve-template).\n3. **Send** it with [Send a message](/docs/whatsapp/messages/send-message), using `\"type\": \"template\"`, the template's `name` and `language`, and a value for each placeholder.\n\n### Categories\n\nEvery template has a category. It decides how WhatsApp reviews and prices it:\n\n- **`MARKETING`**: offers, announcements, newsletters, and anything that encourages a purchase.\n- **`UTILITY`**: updates about something the customer asked for or bought, such as order confirmations, shipping updates and appointment reminders.\n- **`AUTHENTICATION`**: one-time passwords (OTP) only. The wording is fixed by WhatsApp; you choose the buttons and expiry.\n\nIf WhatsApp thinks you picked the wrong category, it changes it and sends a [template category](/docs/whatsapp/events/template-category) event. Set `allow_category_change: true` to accept this instead of having the template rejected.\n\n### Parts of a template\n\n- **Header** (optional): text (up to 60 characters), an image, a video, a document or a location.\n- **Body** (required): the main text, up to 1,024 characters, with WhatsApp formatting.\n- **Footer** (optional): small grey text, up to 60 characters.\n- **Buttons** (optional): up to 10 in total:\n  - quick replies,\n  - up to 2 website links,\n  - 1 phone number,\n  - 1 copy-code button,\n  - or a catalog or multi-product button.\n- **Carousel** (optional): 2 to 10 swipeable cards, each with its own image or video, text and buttons.\n- **Limited-time offer** (optional): an expiring-offer banner with a countdown. Marketing templates only, with stricter rules; see [Rules worth knowing](#rules-worth-knowing).\n\n### Placeholders\n\nWrite placeholders as `{{1}}`, `{{2}}` and so on, and give an example value for each so the reviewers understand the template. When you send, you supply the real values in the same order.\n\n```json\n{ \"type\": \"BODY\", \"text\": \"Hi {{1}}, your order {{2}} has shipped.\", \"example\": { \"body_text\": [[\"Priya\", \"#1042\"]] } }\n```\n\n#### Named placeholders\n\nYou can name placeholders instead, such as `{{first_name}}`: lowercase letters and underscores, each name used once. Set `\"parameter_format\": \"NAMED\"` when you create the template, and give the examples by name in `body_text_named_params` (or `header_text_named_params` for a text header):\n\n```json\n{ \"type\": \"BODY\", \"text\": \"Hi {{first_name}}, your order {{order_id}} has shipped.\", \"example\": { \"body_text_named_params\": [{ \"param_name\": \"first_name\", \"example\": \"Priya\" }, { \"param_name\": \"order_id\", \"example\": \"#1042\" }] } }\n```\n\nWhen you send, add `parameter_name` to each text value: `{ \"type\": \"text\", \"parameter_name\": \"first_name\", \"text\": \"Priya\" }`. Templates you read back carry `parameter_format`, `POSITIONAL` or `NAMED`, so you know which way to fill them. Templates made in WhatsApp Manager can be either.\n\n### Rules worth knowing\n\n- **Names** use lowercase letters, numbers and underscores only, such as `order_shipped`. One name can have several languages.\n- **Media headers** need a sample file when you create the template. Upload it with [Template samples](/docs/whatsapp/template-samples) and put the returned handle in `example.header_handle`. When you *send*, you supply the real file.\n- **Editing** an approved template sends it back for review. You can edit an approved template once a day, and 10 times in 30 days.\n- **Deleting** by name deletes every language of that template. You can't reuse a deleted name for 30 days. A deleted template can still appear in [List templates](/docs/whatsapp/templates/list-templates) for a minute or two.\n- **Limited-time offers** are for `MARKETING` templates only. The header is optional and must be an image or a video. There's no footer, the body is up to 600 characters, and a website button is required; a copy-code button is optional. Customers on WhatsApp Web and desktop don't see the offer.\n- **Quality** is judged on how customers react. A template that many customers block or report can be `PAUSED` for a few hours, and then `DISABLED`.\n"
    },
    {
      "name": "Template samples",
      "description": "When you create a template with an image, video or document header, WhatsApp's reviewers need a sample of that file. You upload the sample in two steps and get back a **handle**, a long string that starts with `4::`. You then put the handle in the template's `example.header_handle`.\n\nThis is separate from [Media](/docs/whatsapp/media). Media IDs are for *sending* messages; handles are only for *creating* templates.\n\n### Steps\n\n1. **[Create an upload session](/docs/whatsapp/template-samples/create-upload-session)** with the file's size in bytes and its type. You get back a session `id` that starts with `upload:`.\n2. **[Upload the file](/docs/whatsapp/template-samples/upload-sample-file)** to that session. You get back the handle `h`.\n3. **Create the template** with the handle:\n\n```json\n{\n  \"type\": \"HEADER\",\n  \"format\": \"IMAGE\",\n  \"example\": { \"header_handle\": [\"4::aW1hZ2UvanBlZw==:ARZ...\"] }\n}\n```\n\nThe sample only helps WhatsApp review the template. Customers never see it; you send the real file each time you use the template.\n"
    },
    {
      "name": "Catalog",
      "description": "A catalog is the list of products you sell on WhatsApp. Customers can browse it inside the chat, add items to a cart and send you an order.\n\n### Before you start\n\nYour catalog lives in Meta's Commerce Manager and must be connected to your WhatsApp Business Account. DoveMesh support can help you connect it. Then:\n\n1. **[Retrieve your catalog ID](/docs/whatsapp/catalog/retrieve-catalog-id)**.\n2. **Add products** with [Create, update or delete products](/docs/whatsapp/catalog/batch-products), or in Commerce Manager. Each product has your own ID for it, the `retailer_id` (your SKU).\n3. **Show products** in messages: a single product, a product list, a product carousel, or a catalog or multi-product template. See [Send a message](/docs/whatsapp/messages/send-message).\n\nWhen a customer sends a cart, your webhook receives an [incoming message](/docs/whatsapp/events/incoming-message) of type `order`. It lists each `product_retailer_id`, the quantity and the price.\n"
    },
    {
      "name": "Payments",
      "description": "Customers in India can pay you inside WhatsApp, using UPI, cards or netbanking, through your own payment gateway account (Razorpay or PayU).\n\n### Before you start\n\nLink your payment gateway to your WhatsApp Business Account in WhatsApp Manager under **Payments**. That creates a **payment configuration** with a name you choose. You'll use the name in every payment request.\n\n### How a payment works\n\n1. **Ask for payment.** Send an `interactive` message of type `order_details` (see [Send a message](/docs/whatsapp/messages/send-message), example *Payment request*). Give the order your own unique `reference_id`.\n2. **The customer pays** without leaving WhatsApp.\n3. **Check the result** with [Retrieve a payment](/docs/whatsapp/payments/retrieve-payment), and always confirm it with your payment gateway before you ship anything.\n4. **Update the customer** with an `order_status` message (example *Order status*).\n5. **Refund** with [Refund a payment](/docs/whatsapp/payments/refund-payment) if needed.\n\n### Amounts\n\nAmounts are written as a `value` and an `offset`. The real amount is `value ÷ offset`, and `offset` is always `100`. So ₹499.00 is `{ \"value\": 49900, \"offset\": 100 }`.\n"
    },
    {
      "name": "QR codes",
      "description": "QR codes and short links let people start a chat with you. When someone scans the code or opens the link, WhatsApp opens a chat with your number and a message you chose already typed in. They just tap send.\n\nPut them on packaging, receipts, posters and your website. Each code has:\n\n- a `code`, its ID,\n- a `deep_link_url` such as `https://wa.me/message/RPASB5GEAP6FO1`, which you can share as a link,\n- a `qr_image_url` for the QR image, if you ask for one as `PNG` or `SVG`.\n\nYou can change the prefilled message later without printing a new code.\n"
    },
    {
      "name": "Flows",
      "description": "WhatsApp Flows are forms and multi-screen experiences inside the chat, such as sign-ups, bookings and surveys. You design Flows in WhatsApp Manager.\n\nA Flow that talks to your server (an *endpoint* Flow) exchanges encrypted data with it. That needs a key pair for your number:\n\n1. **[Set up the encryption key](/docs/whatsapp/flows/set-flows-encryption-key)** once per number.\n2. **[Retrieve the private key](/docs/whatsapp/flows/retrieve-flows-private-key)** and store it securely on your server. It decrypts the requests WhatsApp sends to your Flow endpoint.\n\nTreat the private key like a password. Anyone who has it can read the data your customers enter in your Flows.\n"
    },
    {
      "name": "Account",
      "description": "Look up the WhatsApp numbers your API key can use, and details of your WhatsApp Business Account.\n\n- **[List your phone numbers](/docs/whatsapp/account/list-phone-numbers)** is the quickest way to check that your key works, and to find your `phone_number_id` and `waba_id`.\n- **[Retrieve your business account](/docs/whatsapp/account/retrieve-business-account)** returns its name, currency, time zone and template namespace.\n- **[Retrieve your message credit balance](/docs/whatsapp/account/retrieve-balance)** returns a number's credit, in your wallet's currency. Check it before a large send.\n\nTo change your business profile (description, address, website, profile picture) or display name, use WhatsApp Manager or contact DoveMesh support. The API doesn't change them.\n"
    }
  ],
  "externalDocs": {
    "description": "Meta's WhatsApp Cloud API reference",
    "url": "https://developers.facebook.com/docs/whatsapp/cloud-api"
  },
  "paths": {
    "/{phone_number_id}/messages": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        }
      ],
      "post": {
        "tags": [
          "Messages"
        ],
        "operationId": "sendMessage",
        "summary": "Send a message",
        "x-seo-description": "Send a WhatsApp message with the API: text, images, documents, buttons, lists, products, payment requests, reactions or an approved template.",
        "description": "Sends one message to one customer. Pick the kind of message under Examples; every example is a complete request you can copy.\n\n- Outside the [24-hour window](/docs/whatsapp/messaging-window), only `template` messages are allowed.\n- To quote an earlier message, add `context.message_id`.\n- To **mark an incoming message as read**, send `\"status\": \"read\"` and its `message_id` instead of a message. The response is then `{ \"success\": true }`.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SendMessageRequest"
              },
              "examples": {
                "text": {
                  "summary": "Text",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "text",
                    "text": {
                      "body": "Your order #1042 has shipped. Track it at https://example.com/t/1042",
                      "preview_url": true
                    }
                  }
                },
                "reply": {
                  "summary": "Text reply (quoting a message)",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "context": {
                      "message_id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTFCMkMzRDRFNUY2"
                    },
                    "type": "text",
                    "text": {
                      "body": "Yes, we're open on Sunday from 10am."
                    }
                  }
                },
                "template_text": {
                  "summary": "Template with text placeholders",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "order_shipped",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "Priya"
                            },
                            {
                              "type": "text",
                              "text": "#1042"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_media": {
                  "summary": "Template with image header",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "new_arrivals",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "header",
                          "parameters": [
                            {
                              "type": "image",
                              "image": {
                                "link": "https://example.com/images/new-arrivals.jpg"
                              }
                            }
                          ]
                        },
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "Priya"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_document": {
                  "summary": "Template with document header",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "invoice_ready",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "header",
                          "parameters": [
                            {
                              "type": "document",
                              "document": {
                                "link": "https://example.com/invoices/INV-2026-0042.pdf",
                                "filename": "INV-2026-0042.pdf"
                              }
                            }
                          ]
                        },
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "₹1,499.00"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_buttons": {
                  "summary": "Template with quick replies and a website button",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "appointment_reminder",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "Friday 3 October, 4:00 PM"
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "quick_reply",
                          "index": "0",
                          "parameters": [
                            {
                              "type": "payload",
                              "payload": "confirm_appt_881"
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "quick_reply",
                          "index": "1",
                          "parameters": [
                            {
                              "type": "payload",
                              "payload": "reschedule_appt_881"
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "url",
                          "index": "2",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "appt-881"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_currency": {
                  "summary": "Template with currency and date",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "payment_due",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "currency",
                              "currency": {
                                "fallback_value": "₹1,499.00",
                                "code": "INR",
                                "amount_1000": 1499000
                              }
                            },
                            {
                              "type": "date_time",
                              "date_time": {
                                "fallback_value": "5 October 2026"
                              }
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_named": {
                  "summary": "Template with named placeholders",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "order_ready",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "header",
                          "parameters": [
                            {
                              "type": "text",
                              "parameter_name": "order_id",
                              "text": "#1042"
                            }
                          ]
                        },
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "parameter_name": "first_name",
                              "text": "Priya"
                            },
                            {
                              "type": "text",
                              "parameter_name": "order_id",
                              "text": "#1042"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_coupon": {
                  "summary": "Template with coupon code",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "festive_coupon",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "25%"
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "copy_code",
                          "index": 0,
                          "parameters": [
                            {
                              "type": "coupon_code",
                              "coupon_code": "DIWALI25"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_lto": {
                  "summary": "Limited-time offer template",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "flash_sale",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "header",
                          "parameters": [
                            {
                              "type": "image",
                              "image": {
                                "link": "https://example.com/images/flash-sale.jpg"
                              }
                            }
                          ]
                        },
                        {
                          "type": "limited_time_offer",
                          "parameters": [
                            {
                              "type": "limited_time_offer",
                              "limited_time_offer": {
                                "expiration_time_ms": 1790956800000
                              }
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "copy_code",
                          "index": 0,
                          "parameters": [
                            {
                              "type": "coupon_code",
                              "coupon_code": "FLASH40"
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "url",
                          "index": 1,
                          "parameters": [
                            {
                              "type": "text",
                              "text": "flash-sale"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_carousel": {
                  "summary": "Carousel template",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "winter_collection",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "Priya"
                            }
                          ]
                        },
                        {
                          "type": "carousel",
                          "cards": [
                            {
                              "card_index": 0,
                              "components": [
                                {
                                  "type": "header",
                                  "parameters": [
                                    {
                                      "type": "image",
                                      "image": {
                                        "id": "1166846181421424"
                                      }
                                    }
                                  ]
                                },
                                {
                                  "type": "button",
                                  "sub_type": "url",
                                  "index": 0,
                                  "parameters": [
                                    {
                                      "type": "text",
                                      "text": "jackets"
                                    }
                                  ]
                                }
                              ]
                            },
                            {
                              "card_index": 1,
                              "components": [
                                {
                                  "type": "header",
                                  "parameters": [
                                    {
                                      "type": "image",
                                      "image": {
                                        "id": "1166846181421425"
                                      }
                                    }
                                  ]
                                },
                                {
                                  "type": "button",
                                  "sub_type": "url",
                                  "index": 0,
                                  "parameters": [
                                    {
                                      "type": "text",
                                      "text": "sweaters"
                                    }
                                  ]
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_catalog": {
                  "summary": "Catalog template",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "browse_catalog",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "button",
                          "sub_type": "catalog",
                          "index": 0,
                          "parameters": [
                            {
                              "type": "action",
                              "action": {
                                "thumbnail_product_retailer_id": "tshirt-blue-m"
                              }
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_mpm": {
                  "summary": "Multi-product template",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "weekend_picks",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "header",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "Priya"
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "mpm",
                          "index": 0,
                          "parameters": [
                            {
                              "type": "action",
                              "action": {
                                "thumbnail_product_retailer_id": "tshirt-blue-m",
                                "sections": [
                                  {
                                    "title": "T-shirts",
                                    "product_items": [
                                      {
                                        "product_retailer_id": "tshirt-blue-m"
                                      },
                                      {
                                        "product_retailer_id": "tshirt-white-m"
                                      }
                                    ]
                                  },
                                  {
                                    "title": "Caps",
                                    "product_items": [
                                      {
                                        "product_retailer_id": "cap-black"
                                      }
                                    ]
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "template_otp": {
                  "summary": "One-time password template",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "template",
                    "template": {
                      "name": "login_code",
                      "language": {
                        "code": "en"
                      },
                      "components": [
                        {
                          "type": "body",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "482913"
                            }
                          ]
                        },
                        {
                          "type": "button",
                          "sub_type": "url",
                          "index": "0",
                          "parameters": [
                            {
                              "type": "text",
                              "text": "482913"
                            }
                          ]
                        }
                      ]
                    }
                  }
                },
                "image": {
                  "summary": "Image",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "image",
                    "image": {
                      "link": "https://example.com/images/menu.jpg",
                      "caption": "This week's menu"
                    }
                  }
                },
                "image_uploaded": {
                  "summary": "Image (uploaded file)",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "image",
                    "image": {
                      "id": "1166846181421424"
                    }
                  }
                },
                "video": {
                  "summary": "Video",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "video",
                    "video": {
                      "link": "https://example.com/videos/setup-guide.mp4",
                      "caption": "How to set up your router"
                    }
                  }
                },
                "audio": {
                  "summary": "Audio",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "audio",
                    "audio": {
                      "link": "https://example.com/audio/welcome.mp3"
                    }
                  }
                },
                "document": {
                  "summary": "Document",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "document",
                    "document": {
                      "link": "https://example.com/invoices/INV-2026-0042.pdf",
                      "filename": "INV-2026-0042.pdf",
                      "caption": "Your invoice for September"
                    }
                  }
                },
                "sticker": {
                  "summary": "Sticker",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "sticker",
                    "sticker": {
                      "link": "https://example.com/stickers/thanks.webp"
                    }
                  }
                },
                "location": {
                  "summary": "Location",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "location",
                    "location": {
                      "latitude": 9.9252,
                      "longitude": 78.1198,
                      "name": "DoveMesh",
                      "address": "Meenakshi Nagar, Madurai, Tamil Nadu"
                    }
                  }
                },
                "contacts": {
                  "summary": "Contact card",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "contacts",
                    "contacts": [
                      {
                        "name": {
                          "formatted_name": "DoveMesh Support",
                          "first_name": "DoveMesh",
                          "last_name": "Support"
                        },
                        "phones": [
                          {
                            "phone": "+919876500000",
                            "type": "WORK",
                            "wa_id": "919876500000"
                          }
                        ],
                        "emails": [
                          {
                            "email": "contact@dovemesh.com",
                            "type": "WORK"
                          }
                        ],
                        "urls": [
                          {
                            "url": "https://www.dovemesh.com",
                            "type": "WORK"
                          }
                        ]
                      }
                    ]
                  }
                },
                "buttons": {
                  "summary": "Reply buttons",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "button",
                      "body": {
                        "text": "Can you make your appointment on Friday at 4pm?"
                      },
                      "footer": {
                        "text": "Reply to confirm"
                      },
                      "action": {
                        "buttons": [
                          {
                            "type": "reply",
                            "reply": {
                              "id": "confirm_1042",
                              "title": "Yes, confirm"
                            }
                          },
                          {
                            "type": "reply",
                            "reply": {
                              "id": "reschedule_1042",
                              "title": "Reschedule"
                            }
                          }
                        ]
                      }
                    }
                  }
                },
                "list": {
                  "summary": "List",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "list",
                      "header": {
                        "type": "text",
                        "text": "Our plans"
                      },
                      "body": {
                        "text": "Pick a plan to see its price and features."
                      },
                      "footer": {
                        "text": "Prices include GST"
                      },
                      "action": {
                        "button": "See plans",
                        "sections": [
                          {
                            "title": "Hosting",
                            "rows": [
                              {
                                "id": "plan_starter",
                                "title": "Starter",
                                "description": "1 website, 10 GB storage"
                              },
                              {
                                "id": "plan_pro",
                                "title": "Pro",
                                "description": "10 websites, 50 GB storage"
                              }
                            ]
                          },
                          {
                            "title": "Email",
                            "rows": [
                              {
                                "id": "plan_email",
                                "title": "Business email",
                                "description": "5 mailboxes on your domain"
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                },
                "link_button": {
                  "summary": "Link button",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "cta_url",
                      "body": {
                        "text": "Your invoice is ready."
                      },
                      "action": {
                        "name": "cta_url",
                        "parameters": {
                          "display_text": "View invoice",
                          "url": "https://example.com/invoices/INV-2026-0042"
                        }
                      }
                    }
                  }
                },
                "location_request": {
                  "summary": "Location request",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "location_request_message",
                      "body": {
                        "text": "Share your location so we can find the nearest store."
                      },
                      "action": {
                        "name": "send_location"
                      }
                    }
                  }
                },
                "address_request": {
                  "summary": "Address request (India)",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "address_message",
                      "body": {
                        "text": "Thanks for your order! Where should we deliver it?"
                      },
                      "action": {
                        "name": "address_message",
                        "parameters": {
                          "country": "IN"
                        }
                      }
                    }
                  }
                },
                "product": {
                  "summary": "Single product",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "product",
                      "body": {
                        "text": "Back in stock in your size."
                      },
                      "action": {
                        "catalog_id": "801262455316921",
                        "product_retailer_id": "tshirt-blue-m"
                      }
                    }
                  }
                },
                "product_list": {
                  "summary": "Product list",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "product_list",
                      "header": {
                        "type": "text",
                        "text": "Our bestsellers"
                      },
                      "body": {
                        "text": "Tap an item to see details and add it to your cart."
                      },
                      "action": {
                        "catalog_id": "801262455316921",
                        "sections": [
                          {
                            "title": "T-shirts",
                            "product_items": [
                              {
                                "product_retailer_id": "tshirt-blue-m"
                              },
                              {
                                "product_retailer_id": "tshirt-white-m"
                              }
                            ]
                          },
                          {
                            "title": "Caps",
                            "product_items": [
                              {
                                "product_retailer_id": "cap-black"
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                },
                "carousel": {
                  "summary": "Carousel of link cards",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "carousel",
                      "body": {
                        "text": "Check out our latest offers!"
                      },
                      "action": {
                        "cards": [
                          {
                            "card_index": 0,
                            "type": "cta_url",
                            "header": {
                              "type": "image",
                              "image": {
                                "link": "https://example.com/images/offer-1.jpg"
                              }
                            },
                            "body": {
                              "text": "20% off hosting"
                            },
                            "action": {
                              "name": "cta_url",
                              "parameters": {
                                "display_text": "Shop now",
                                "url": "https://example.com/offers/hosting"
                              }
                            }
                          },
                          {
                            "card_index": 1,
                            "type": "cta_url",
                            "header": {
                              "type": "image",
                              "image": {
                                "link": "https://example.com/images/offer-2.jpg"
                              }
                            },
                            "body": {
                              "text": "Free domain for a year"
                            },
                            "action": {
                              "name": "cta_url",
                              "parameters": {
                                "display_text": "Claim offer",
                                "url": "https://example.com/offers/domain"
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                },
                "product_carousel": {
                  "summary": "Carousel of products",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "carousel",
                      "body": {
                        "text": "Picked for you"
                      },
                      "action": {
                        "cards": [
                          {
                            "card_index": 0,
                            "type": "product",
                            "action": {
                              "catalog_id": "801262455316921",
                              "product_retailer_id": "tshirt-blue-m"
                            }
                          },
                          {
                            "card_index": 1,
                            "type": "product",
                            "action": {
                              "catalog_id": "801262455316921",
                              "product_retailer_id": "cap-black"
                            }
                          }
                        ]
                      }
                    }
                  }
                },
                "payment_request": {
                  "summary": "Payment request (India)",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "order_details",
                      "body": {
                        "text": "Please pay for your order"
                      },
                      "action": {
                        "name": "review_and_pay",
                        "parameters": {
                          "reference_id": "order-1042",
                          "type": "physical-goods",
                          "currency": "INR",
                          "total_amount": {
                            "value": 104800,
                            "offset": 100
                          },
                          "payment_settings": [
                            {
                              "type": "payment_gateway",
                              "payment_gateway": {
                                "type": "razorpay",
                                "configuration_name": "main-store"
                              }
                            }
                          ],
                          "order": {
                            "status": "pending",
                            "items": [
                              {
                                "retailer_id": "tshirt-blue-m",
                                "name": "Blue T-shirt (M)",
                                "amount": {
                                  "value": 49900,
                                  "offset": 100
                                },
                                "quantity": 2
                              }
                            ],
                            "subtotal": {
                              "value": 99800,
                              "offset": 100
                            },
                            "shipping": {
                              "value": 5000,
                              "offset": 100
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "order_status": {
                  "summary": "Order status",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "interactive",
                    "interactive": {
                      "type": "order_status",
                      "body": {
                        "text": "Payment received. Your order is being packed."
                      },
                      "action": {
                        "name": "review_order",
                        "parameters": {
                          "reference_id": "order-1042",
                          "order": {
                            "status": "completed",
                            "description": "Ships within 2 days"
                          }
                        }
                      }
                    }
                  }
                },
                "reaction": {
                  "summary": "Reaction",
                  "value": {
                    "messaging_product": "whatsapp",
                    "to": "919876543210",
                    "type": "reaction",
                    "reaction": {
                      "message_id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTFCMkMzRDRFNUY2",
                      "emoji": "👍"
                    }
                  }
                },
                "mark_read": {
                  "summary": "Mark as read",
                  "value": {
                    "messaging_product": "whatsapp",
                    "status": "read",
                    "message_id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTFCMkMzRDRFNUY2"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The message was accepted. Delivery is reported later on your webhook.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/SendResponse"
                    },
                    {
                      "$ref": "#/components/schemas/ReadResponse"
                    }
                  ]
                },
                "examples": {
                  "sent": {
                    "summary": "Message accepted",
                    "value": {
                      "messaging_product": "whatsapp",
                      "contacts": [
                        {
                          "input": "919876543210",
                          "wa_id": "919876543210"
                        }
                      ],
                      "messages": [
                        {
                          "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSNzM0QkY3RURGMzhDQ0M1ODAA"
                        }
                      ]
                    }
                  },
                  "template_sent": {
                    "summary": "Template accepted",
                    "value": {
                      "messaging_product": "whatsapp",
                      "contacts": [
                        {
                          "input": "919876543210",
                          "wa_id": "919876543210"
                        }
                      ],
                      "messages": [
                        {
                          "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSNzM0QkY3RURGMzhDQ0M1ODAA",
                          "message_status": "accepted"
                        }
                      ]
                    }
                  },
                  "read": {
                    "summary": "Marked as read",
                    "value": {
                      "success": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/AccountSuspended"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{phone_number_id}/media": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        }
      ],
      "post": {
        "tags": [
          "Media"
        ],
        "operationId": "uploadMedia",
        "summary": "Upload media",
        "x-seo-description": "Upload an image, video, audio file or document to WhatsApp and get a media ID you can send for 30 days.",
        "description": "Uploads a file so you can send it by `id` instead of by link. The upload uses form data (`multipart/form-data`), not JSON, and the file goes in a field named **`sheet`**.\n\nUploaded files are kept for 30 days. Check the [supported types and sizes](/docs/whatsapp/media) first.\n",
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/UploadMediaRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The file was uploaded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaUploaded"
                },
                "example": {
                  "response": {
                    "id": "1166846181421424"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{media_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/MediaId"
        },
        {
          "$ref": "#/components/parameters/MediaPhoneNumberQuery"
        }
      ],
      "get": {
        "tags": [
          "Media"
        ],
        "operationId": "retrieveMediaUrl",
        "summary": "Retrieve a media URL",
        "x-seo-description": "Get a temporary download link, type, size and checksum for a WhatsApp media file you uploaded or a customer sent.",
        "description": "Returns a temporary download link for a file, plus its type, size and checksum.\n\nFetch the `url` with your `apikey` header, as shown in [Download media from its URL](/docs/whatsapp/media/download-media-from-url). The link expires after **5 minutes**; call this again for a fresh one. To skip this step, use [Download media](/docs/whatsapp/media/download-media).\n",
        "responses": {
          "200": {
            "description": "The file's details and download link.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaUrl"
                },
                "example": {
                  "url": "https://wa.dovemesh.com/v3/whatsapp_business/attachments/?mid=1166846181421424&ext=1790506200&hash=ATtFkAs7t1xlhx9wik43m7NBRARfMzfh6Vi_IvgzzxkQsQ",
                  "mime_type": "image/jpeg",
                  "sha256": "ee490eac2a7b038413ab2fb0bfc6db02d9a68e015d92e917fbcee9e324a96810",
                  "file_size": 436484,
                  "id": "1166846181421424",
                  "messaging_product": "whatsapp"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      },
      "delete": {
        "tags": [
          "Media"
        ],
        "operationId": "deleteMedia",
        "summary": "Delete media",
        "x-seo-description": "Delete a media file you uploaded to WhatsApp so its media ID can no longer be used.",
        "description": "Deletes a file you uploaded, so its `id` can no longer be used. Messages already sent keep their copy.",
        "responses": {
          "200": {
            "$ref": "#/components/responses/Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/downloadMedia/{media_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/MediaId"
        },
        {
          "$ref": "#/components/parameters/MediaPhoneNumberQuery"
        }
      ],
      "post": {
        "tags": [
          "Media"
        ],
        "operationId": "downloadMedia",
        "summary": "Download media",
        "x-seo-description": "Download a WhatsApp media file, such as a photo a customer sent, in one step using its media ID.",
        "description": "Downloads a file in one step, using its media ID. The response body is the file itself, with its type in the `Content-Type` header. Save it to your own storage.",
        "responses": {
          "200": {
            "description": "The file.",
            "content": {
              "application/octet-stream": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/whatsapp_business/attachments/": {
      "get": {
        "tags": [
          "Media"
        ],
        "operationId": "downloadMediaFromUrl",
        "summary": "Download media from its URL",
        "x-seo-description": "Download a WhatsApp media file from the temporary URL returned by Retrieve a media URL.",
        "description": "Downloads a file from the `url` returned by [Retrieve a media URL](/docs/whatsapp/media/retrieve-media-url). Call the URL **exactly as returned**, with your `apikey` header, within 5 minutes. The response body is the file.\n\nThe query parameters below are part of that URL; you don't build them yourself.\n",
        "parameters": [
          {
            "name": "mid",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "example": "1166846181421424"
            }
          },
          {
            "name": "ext",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "example": "1790506200"
            }
          },
          {
            "name": "hash",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "example": "ATtFkAs7t1xlhx9wik43m7NBRARfMzfh6Vi_IvgzzxkQsQ"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The file.",
            "content": {
              "application/octet-stream": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "description": "The link has expired or is wrong. Get a new one with [Retrieve a media URL](/docs/whatsapp/media/retrieve-media-url)."
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{waba_id}/message_templates": {
      "parameters": [
        {
          "$ref": "#/components/parameters/WabaId"
        }
      ],
      "get": {
        "tags": [
          "Templates"
        ],
        "operationId": "listTemplates",
        "summary": "List templates",
        "x-seo-description": "List your WhatsApp message templates with their approval status, category and content, filtered by status and paged.",
        "description": "Returns your templates, newest first, with their status and content. Use `status` to list only templates you can send (`APPROVED`), and `fields` to return only what you need.\n\nResults come in pages. When `paging.cursors.after` is present, pass it as `after` to get the next page.\n",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "Only templates with this status.",
            "schema": {
              "$ref": "#/components/schemas/TemplateStatus"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Comma-separated fields to return, such as `name,status,language`. Leave it out to get everything.",
            "schema": {
              "type": "string",
              "example": "name,status,language,category"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Templates per page.",
            "schema": {
              "type": "integer",
              "example": 25
            }
          },
          {
            "name": "after",
            "in": "query",
            "description": "Cursor for the next page, from `paging.cursors.after`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "description": "Cursor for the previous page, from `paging.cursors.before`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of templates.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateList"
                },
                "example": {
                  "data": [
                    {
                      "id": "594425479261596",
                      "name": "order_shipped",
                      "parameter_format": "POSITIONAL",
                      "language": "en",
                      "status": "APPROVED",
                      "category": "UTILITY",
                      "disable_ios_autofill": false,
                      "is_primary_device_delivery_only": false,
                      "components": [
                        {
                          "type": "BODY",
                          "text": "Hi {{1}}, your order {{2}} has shipped.",
                          "example": {
                            "body_text": [
                              [
                                "Priya",
                                "#1042"
                              ]
                            ]
                          }
                        }
                      ]
                    },
                    {
                      "id": "594425479261597",
                      "name": "diwali_offer",
                      "parameter_format": "POSITIONAL",
                      "language": "en",
                      "status": "REJECTED",
                      "category": "MARKETING",
                      "disable_ios_autofill": false,
                      "is_primary_device_delivery_only": false,
                      "rejected_reason": "INCORRECT_CATEGORY",
                      "components": [
                        {
                          "type": "BODY",
                          "text": "Get 30% off everything this Diwali!"
                        }
                      ]
                    }
                  ],
                  "paging": {
                    "cursors": {
                      "before": "QVFIUmxtNVRpSjJ",
                      "after": "QVFIUlZAPOEdrMVJ"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      },
      "post": {
        "tags": [
          "Templates"
        ],
        "operationId": "createTemplate",
        "summary": "Create a template",
        "x-seo-description": "Create a WhatsApp message template and submit it for approval: text, media, buttons, coupons, carousels, catalogs and one-time passwords.",
        "description": "Submits a new template for WhatsApp to review. It's usually `PENDING`, and the decision arrives on your webhook as a [template status](/docs/whatsapp/events/template-status) event, usually within minutes. WhatsApp can also approve or reject a template straight away, so check `status` in the response. Authentication templates are often `APPROVED` at once.\n\nPick a kind of template under Examples. Templates with an image, video or document header need a [sample file](/docs/whatsapp/template-samples) first.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateTemplateRequest"
              },
              "examples": {
                "text": {
                  "summary": "Text with placeholders",
                  "value": {
                    "name": "order_shipped",
                    "language": "en",
                    "category": "UTILITY",
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "TEXT",
                        "text": "Order {{1}} shipped",
                        "example": {
                          "header_text": [
                            "#1042"
                          ]
                        }
                      },
                      {
                        "type": "BODY",
                        "text": "Hi {{1}}, your order {{2}} is on its way and should arrive by {{3}}.",
                        "example": {
                          "body_text": [
                            [
                              "Priya",
                              "#1042",
                              "Friday"
                            ]
                          ]
                        }
                      },
                      {
                        "type": "FOOTER",
                        "text": "Reply STOP to opt out"
                      }
                    ]
                  }
                },
                "named": {
                  "summary": "Named placeholders",
                  "value": {
                    "name": "order_ready",
                    "language": "en",
                    "category": "UTILITY",
                    "parameter_format": "NAMED",
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "TEXT",
                        "text": "Order {{order_id}} is ready",
                        "example": {
                          "header_text_named_params": [
                            {
                              "param_name": "order_id",
                              "example": "#1042"
                            }
                          ]
                        }
                      },
                      {
                        "type": "BODY",
                        "text": "Hi {{first_name}}, your order {{order_id}} is ready for pickup.",
                        "example": {
                          "body_text_named_params": [
                            {
                              "param_name": "first_name",
                              "example": "Priya"
                            },
                            {
                              "param_name": "order_id",
                              "example": "#1042"
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "quick_replies": {
                  "summary": "Quick reply buttons",
                  "value": {
                    "name": "appointment_reminder",
                    "language": "en",
                    "category": "UTILITY",
                    "components": [
                      {
                        "type": "BODY",
                        "text": "Reminder: your appointment is on {{1}}. Can you make it?",
                        "example": {
                          "body_text": [
                            [
                              "Friday 3 October, 4:00 PM"
                            ]
                          ]
                        }
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "QUICK_REPLY",
                            "text": "Yes, confirm"
                          },
                          {
                            "type": "QUICK_REPLY",
                            "text": "Reschedule"
                          }
                        ]
                      }
                    ]
                  }
                },
                "call_to_action": {
                  "summary": "Website and phone buttons",
                  "value": {
                    "name": "track_order",
                    "language": "en",
                    "category": "UTILITY",
                    "components": [
                      {
                        "type": "BODY",
                        "text": "Your order {{1}} has shipped.",
                        "example": {
                          "body_text": [
                            [
                              "#1042"
                            ]
                          ]
                        }
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "URL",
                            "text": "Track order",
                            "url": "https://example.com/track/{{1}}",
                            "example": [
                              "https://example.com/track/1042"
                            ]
                          },
                          {
                            "type": "PHONE_NUMBER",
                            "text": "Call us",
                            "phone_number": "+919876500000"
                          }
                        ]
                      }
                    ]
                  }
                },
                "image": {
                  "summary": "Image header",
                  "value": {
                    "name": "new_arrivals",
                    "language": "en",
                    "category": "MARKETING",
                    "allow_category_change": true,
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "IMAGE",
                        "example": {
                          "header_handle": [
                            "4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0:e:1790592000:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw"
                          ]
                        }
                      },
                      {
                        "type": "BODY",
                        "text": "Hi {{1}}, our new collection just arrived. Take a look!",
                        "example": {
                          "body_text": [
                            [
                              "Priya"
                            ]
                          ]
                        }
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "URL",
                            "text": "Shop now",
                            "url": "https://example.com/new"
                          }
                        ]
                      }
                    ]
                  }
                },
                "document": {
                  "summary": "Document header",
                  "value": {
                    "name": "invoice_ready",
                    "language": "en",
                    "category": "UTILITY",
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "DOCUMENT",
                        "example": {
                          "header_handle": [
                            "4::YXBwbGljYXRpb24vcGRm:ARac4zlVCzW2i288Rz9DuNCTMKu:e:1790592000:1849455295211775:100061459561823:ARac3SVKDd8jGKv71WU"
                          ]
                        }
                      },
                      {
                        "type": "BODY",
                        "text": "Your invoice for {{1}} is attached.",
                        "example": {
                          "body_text": [
                            [
                              "₹1,499.00"
                            ]
                          ]
                        }
                      }
                    ]
                  }
                },
                "video": {
                  "summary": "Video header",
                  "value": {
                    "name": "setup_video",
                    "language": "en",
                    "category": "UTILITY",
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "VIDEO",
                        "example": {
                          "header_handle": [
                            "4::dmlkZW8vbXA0:ARbNWS0mwAGyq_FmWUp9Gm_u8Zar5sqUSoGztiz0:e:1790592000:1849455295211775:100061459561823:ARaHLczy0Y0rQTfk_yc"
                          ]
                        }
                      },
                      {
                        "type": "BODY",
                        "text": "Here's a 2-minute video on setting up your router."
                      }
                    ]
                  }
                },
                "location": {
                  "summary": "Location header",
                  "value": {
                    "name": "store_directions",
                    "language": "en",
                    "category": "UTILITY",
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "LOCATION"
                      },
                      {
                        "type": "BODY",
                        "text": "Your order {{1}} is ready for pickup at this store.",
                        "example": {
                          "body_text": [
                            [
                              "#1042"
                            ]
                          ]
                        }
                      }
                    ]
                  }
                },
                "coupon": {
                  "summary": "Coupon code",
                  "value": {
                    "name": "festive_coupon",
                    "language": "en",
                    "category": "MARKETING",
                    "components": [
                      {
                        "type": "BODY",
                        "text": "Celebrate with {{1}} off your next order!",
                        "example": {
                          "body_text": [
                            [
                              "25%"
                            ]
                          ]
                        }
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "COPY_CODE",
                            "example": "DIWALI25"
                          },
                          {
                            "type": "URL",
                            "text": "Shop now",
                            "url": "https://example.com/sale"
                          }
                        ]
                      }
                    ]
                  }
                },
                "limited_time_offer": {
                  "summary": "Limited-time offer",
                  "value": {
                    "name": "flash_sale",
                    "language": "en",
                    "category": "MARKETING",
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "IMAGE",
                        "example": {
                          "header_handle": [
                            "4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0:e:1790592000:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw"
                          ]
                        }
                      },
                      {
                        "type": "LIMITED_TIME_OFFER",
                        "limited_time_offer": {
                          "text": "Flash sale!",
                          "has_expiration": true
                        }
                      },
                      {
                        "type": "BODY",
                        "text": "40% off hosting plans, today only."
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "COPY_CODE",
                            "example": "FLASH40"
                          },
                          {
                            "type": "URL",
                            "text": "Shop now",
                            "url": "https://example.com/{{1}}",
                            "example": [
                              "https://example.com/flash-sale"
                            ]
                          }
                        ]
                      }
                    ]
                  }
                },
                "carousel": {
                  "summary": "Carousel",
                  "value": {
                    "name": "winter_collection",
                    "language": "en",
                    "category": "MARKETING",
                    "components": [
                      {
                        "type": "BODY",
                        "text": "Hi {{1}}, here's what's new this winter.",
                        "example": {
                          "body_text": [
                            [
                              "Priya"
                            ]
                          ]
                        }
                      },
                      {
                        "type": "CAROUSEL",
                        "cards": [
                          {
                            "components": [
                              {
                                "type": "HEADER",
                                "format": "IMAGE",
                                "example": {
                                  "header_handle": [
                                    "4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0:e:1790592000:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw"
                                  ]
                                }
                              },
                              {
                                "type": "BODY",
                                "text": "Warm jackets from ₹1,999."
                              },
                              {
                                "type": "BUTTONS",
                                "buttons": [
                                  {
                                    "type": "URL",
                                    "text": "Shop jackets",
                                    "url": "https://example.com/{{1}}",
                                    "example": [
                                      "https://example.com/jackets"
                                    ]
                                  }
                                ]
                              }
                            ]
                          },
                          {
                            "components": [
                              {
                                "type": "HEADER",
                                "format": "IMAGE",
                                "example": {
                                  "header_handle": [
                                    "4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0:e:1790592000:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw"
                                  ]
                                }
                              },
                              {
                                "type": "BODY",
                                "text": "Cosy sweaters from ₹999."
                              },
                              {
                                "type": "BUTTONS",
                                "buttons": [
                                  {
                                    "type": "URL",
                                    "text": "Shop sweaters",
                                    "url": "https://example.com/{{1}}",
                                    "example": [
                                      "https://example.com/sweaters"
                                    ]
                                  }
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                },
                "catalog": {
                  "summary": "Catalog",
                  "value": {
                    "name": "browse_catalog",
                    "language": "en",
                    "category": "MARKETING",
                    "components": [
                      {
                        "type": "BODY",
                        "text": "Browse our full range and order right here in WhatsApp."
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "CATALOG",
                            "text": "View catalog"
                          }
                        ]
                      }
                    ]
                  }
                },
                "multi_product": {
                  "summary": "Multi-product",
                  "value": {
                    "name": "weekend_picks",
                    "language": "en",
                    "category": "MARKETING",
                    "components": [
                      {
                        "type": "HEADER",
                        "format": "TEXT",
                        "text": "Picks for {{1}}",
                        "example": {
                          "header_text": [
                            "Priya"
                          ]
                        }
                      },
                      {
                        "type": "BODY",
                        "text": "Our favourite products this weekend."
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "MPM",
                            "text": "View items"
                          }
                        ]
                      }
                    ]
                  }
                },
                "otp_copy_code": {
                  "summary": "One-time password (copy code)",
                  "value": {
                    "name": "login_code",
                    "language": "en",
                    "category": "AUTHENTICATION",
                    "message_send_ttl_seconds": 300,
                    "components": [
                      {
                        "type": "BODY",
                        "add_security_recommendation": true
                      },
                      {
                        "type": "FOOTER",
                        "code_expiration_minutes": 5
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "OTP",
                            "otp_type": "copy_code",
                            "text": "Copy code"
                          }
                        ]
                      }
                    ]
                  }
                },
                "otp_one_tap": {
                  "summary": "One-time password (one tap, Android)",
                  "value": {
                    "name": "app_login_code",
                    "language": "en",
                    "category": "AUTHENTICATION",
                    "message_send_ttl_seconds": 300,
                    "components": [
                      {
                        "type": "BODY",
                        "add_security_recommendation": true
                      },
                      {
                        "type": "FOOTER",
                        "code_expiration_minutes": 5
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "OTP",
                            "otp_type": "one_tap",
                            "text": "Copy code",
                            "autofill_text": "Autofill",
                            "supported_apps": [
                              {
                                "package_name": "com.example.app",
                                "signature_hash": "K8a/2FAINcG"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                },
                "otp_zero_tap": {
                  "summary": "One-time password (zero tap, Android)",
                  "value": {
                    "name": "app_silent_code",
                    "language": "en",
                    "category": "AUTHENTICATION",
                    "message_send_ttl_seconds": 60,
                    "components": [
                      {
                        "type": "BODY",
                        "add_security_recommendation": true
                      },
                      {
                        "type": "FOOTER",
                        "code_expiration_minutes": 5
                      },
                      {
                        "type": "BUTTONS",
                        "buttons": [
                          {
                            "type": "OTP",
                            "otp_type": "zero_tap",
                            "text": "Copy code",
                            "autofill_text": "Autofill",
                            "zero_tap_terms_accepted": true,
                            "supported_apps": [
                              {
                                "package_name": "com.example.app",
                                "signature_hash": "K8a/2FAINcG"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The template was submitted. `status` says whether WhatsApp is still reviewing it or has already decided.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateCreated"
                },
                "examples": {
                  "pending": {
                    "summary": "In review",
                    "value": {
                      "id": "594425479261596",
                      "status": "PENDING",
                      "category": "UTILITY"
                    }
                  },
                  "approved": {
                    "summary": "Approved at once",
                    "value": {
                      "id": "594425479261598",
                      "status": "APPROVED",
                      "category": "AUTHENTICATION"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      },
      "delete": {
        "tags": [
          "Templates"
        ],
        "operationId": "deleteTemplate",
        "summary": "Delete a template",
        "x-seo-description": "Delete a WhatsApp message template in every language or in one language. A deleted name can't be reused for 30 days.",
        "description": "Deletes a template.\n\n- With only `name`, every language of that template is deleted.\n- With `name` and `hsm_id` (the template ID), only that one language is deleted.\n\nYou can't create a template with a deleted name for 30 days. Messages already sent aren't affected.\n\n`\"success\": true` confirms the delete. [List templates](/docs/whatsapp/templates/list-templates) can still return the template, with its old status, for a minute or two afterwards, so don't confirm a delete by listing again.\n",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "required": true,
            "description": "The template's name.",
            "schema": {
              "type": "string",
              "example": "diwali_offer"
            }
          },
          {
            "name": "hsm_id",
            "in": "query",
            "description": "The template ID, to delete only one language.",
            "schema": {
              "type": "string",
              "example": "594425479261597"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/Success"
          },
          "400": {
            "description": "WhatsApp rejected the request. `error.code` says why; see [Errors](/docs/whatsapp/errors).\n\nA name that isn't on your account, for example one already deleted, gives `error.code` `100` with `(#100) Invalid parameter` and a detail saying the template \"wasn't found for this account\". You can treat it as already deleted.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WhatsAppError"
                },
                "example": {
                  "error": {
                    "message": "(#100) Invalid parameter",
                    "type": "OAuthException",
                    "code": 100,
                    "fbtrace_id": "AbCdEfGh123"
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{template_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/TemplateId"
        }
      ],
      "get": {
        "tags": [
          "Templates"
        ],
        "operationId": "retrieveTemplate",
        "summary": "Retrieve a template",
        "x-seo-description": "Get one WhatsApp message template with its approval status, category and content.",
        "description": "Returns one template with its status, category and content. Useful to check whether a template is approved before you send it.",
        "responses": {
          "200": {
            "description": "The template.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Template"
                },
                "example": {
                  "id": "594425479261596",
                  "name": "flash_sale",
                  "parameter_format": "POSITIONAL",
                  "language": "en",
                  "status": "APPROVED",
                  "category": "MARKETING",
                  "disable_ios_autofill": false,
                  "is_primary_device_delivery_only": false,
                  "components": [
                    {
                      "type": "LIMITED_TIME_OFFER",
                      "limited_time_offer": {
                        "text": "Flash sale!",
                        "has_expiration": true
                      }
                    },
                    {
                      "type": "BODY",
                      "text": "40% off hosting plans, today only."
                    },
                    {
                      "type": "BUTTONS",
                      "buttons": [
                        {
                          "type": "COPY_CODE",
                          "example": [
                            "FLASH40"
                          ]
                        },
                        {
                          "type": "URL",
                          "text": "Shop now",
                          "url": "https://example.com/{{1}}",
                          "example": [
                            "https://example.com/flash-sale"
                          ]
                        }
                      ]
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      },
      "post": {
        "tags": [
          "Templates"
        ],
        "operationId": "updateTemplate",
        "summary": "Edit a template",
        "x-seo-description": "Edit a WhatsApp message template's content or category. The template goes back to review before you can send it again.",
        "description": "Changes a template's content, its category, or both. The edited template goes back to review, and you can't send it until it's approved again.\n\n- Only templates that are `APPROVED`, `REJECTED` or `PAUSED` can be edited.\n- An approved template can be edited once a day, and up to 10 times in 30 days.\n- The name and language can't change. To rename, create a new template.\n- Send the **complete** new list of components, not just the parts that change.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateTemplateRequest"
              },
              "examples": {
                "components": {
                  "summary": "New content",
                  "value": {
                    "components": [
                      {
                        "type": "BODY",
                        "text": "Hi {{1}}, your order {{2}} has shipped and arrives {{3}}.",
                        "example": {
                          "body_text": [
                            [
                              "Priya",
                              "#1042",
                              "tomorrow"
                            ]
                          ]
                        }
                      },
                      {
                        "type": "FOOTER",
                        "text": "Reply STOP to opt out"
                      }
                    ]
                  }
                },
                "category": {
                  "summary": "New category",
                  "value": {
                    "category": "UTILITY"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/app/uploads": {
      "post": {
        "tags": [
          "Template samples"
        ],
        "operationId": "createUploadSession",
        "summary": "Create an upload session",
        "x-seo-description": "Start uploading a sample image, video or document for a WhatsApp template with a media header (step 1 of 2).",
        "description": "Step 1 of uploading a template sample. Tell WhatsApp the file's size and type; you get back a session `id` for [step 2](/docs/whatsapp/template-samples/upload-sample-file).",
        "parameters": [
          {
            "name": "file_length",
            "in": "query",
            "required": true,
            "description": "Size of the file in bytes.",
            "schema": {
              "type": "integer",
              "example": 164313
            }
          },
          {
            "name": "file_type",
            "in": "query",
            "required": true,
            "description": "The file's type, such as `image/jpeg`, `image/png`, `video/mp4` or `application/pdf`.",
            "schema": {
              "type": "string",
              "example": "image/jpeg"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The session was created.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadSession"
                },
                "example": {
                  "id": "upload:MTphdHRhY2htZW50OjNlYTE1ZTkzLTZkZDktNGIwOS1iOTM3LWM4YWZmMTRkYTZkMz9maWxlX2xlbmd0aD0xNjQzMTM?sig=ARbUFIDlNcIbRnOalIY"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/upload:{upload_session_id}": {
      "post": {
        "tags": [
          "Template samples"
        ],
        "operationId": "uploadSampleFile",
        "summary": "Upload the file",
        "x-seo-description": "Upload a template sample file and get the header handle you need to create a WhatsApp media template (step 2 of 2).",
        "description": "Step 2 of uploading a template sample. Send the file's raw bytes (not form data) to the session from [step 1](/docs/whatsapp/template-samples/create-upload-session).\n\nThe session `id` from step 1 looks like `upload:MTph…?sig=ARb…`. Append it to the base URL exactly as returned: the part after `upload:` and before `?` is `upload_session_id`, and `sig` is the query parameter.\n\nYou get back the handle `h`. Use it in `example.header_handle` when you [create the template](/docs/whatsapp/templates/create-template).\n",
        "parameters": [
          {
            "name": "upload_session_id",
            "in": "path",
            "required": true,
            "description": "The session ID from step 1, without the `upload:` prefix and without `?sig=…`.",
            "schema": {
              "type": "string",
              "example": "MTphdHRhY2htZW50OjNlYTE1ZTkzLTZkZDktNGIwOS1iOTM3LWM4YWZmMTRkYTZkMz9maWxlX2xlbmd0aD0xNjQzMTM"
            }
          },
          {
            "name": "sig",
            "in": "query",
            "required": true,
            "description": "The `sig` value from the end of the session ID.",
            "schema": {
              "type": "string",
              "example": "ARbUFIDlNcIbRnOalIY"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The file was uploaded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadHandle"
                },
                "example": {
                  "h": "4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0:e:1790592000:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/fetchcatalogId": {
      "get": {
        "tags": [
          "Catalog"
        ],
        "operationId": "retrieveCatalogId",
        "summary": "Retrieve your catalog ID",
        "x-seo-description": "Get the ID of the product catalog connected to your WhatsApp number, to manage products and send them in chats.",
        "description": "Returns the ID of the product catalog connected to your WhatsApp number. Send the number in the `wanumber` header.\n\nWhen no catalog is connected, the answer is still `200` with the same success message, but `catlogid` is `null`. Check `catlogid`, not `message`.\n",
        "parameters": [
          {
            "name": "wanumber",
            "in": "header",
            "required": true,
            "description": "Your WhatsApp number with country code, such as `919876500000`.",
            "schema": {
              "type": "string",
              "example": "919876500000"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Your catalog ID, or `null` when no catalog is connected.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogIdResult"
                },
                "examples": {
                  "connected": {
                    "summary": "Catalog connected",
                    "value": {
                      "code": 200,
                      "status": "SUCCESS",
                      "message": "Catalog data fetch successfully",
                      "data": {
                        "catlogid": "801262455316921"
                      }
                    }
                  },
                  "not_connected": {
                    "summary": "No catalog connected",
                    "value": {
                      "code": 200,
                      "status": "SUCCESS",
                      "message": "Catalog data fetch successfully",
                      "data": {
                        "catlogid": null
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{catalog_id}/products": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogId"
        }
      ],
      "get": {
        "tags": [
          "Catalog"
        ],
        "operationId": "listProducts",
        "summary": "List products",
        "x-seo-description": "List and search the products in your WhatsApp product catalog with the API, to check what customers can browse in chats.",
        "description": "Returns the products in your catalog. Use `filter` to search, `fields` to choose what's returned, and `after` to page through.",
        "parameters": [
          {
            "name": "fields",
            "in": "query",
            "description": "Fields to return, as a JSON list.",
            "schema": {
              "type": "string",
              "example": "[\"retailer_id\",\"name\",\"price\",\"availability\",\"image_url\"]"
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "A JSON search filter, such as products whose name contains a word.",
            "schema": {
              "type": "string",
              "example": "{\"name\":{\"i_contains\":\"t-shirt\"}}"
            }
          },
          {
            "name": "summary",
            "in": "query",
            "description": "Include the total number of products.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Products per page.",
            "schema": {
              "type": "integer",
              "example": 25
            }
          },
          {
            "name": "after",
            "in": "query",
            "description": "Cursor for the next page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of products.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogProducts"
                },
                "example": {
                  "data": [
                    {
                      "id": "7241836912544032",
                      "retailer_id": "tshirt-blue-m",
                      "name": "Blue T-shirt (M)",
                      "price": "₹499.00",
                      "availability": "in stock",
                      "image_url": "https://example.com/images/tshirt-blue.jpg"
                    }
                  ],
                  "paging": {
                    "cursors": {
                      "before": "QVFIUmxtNVRpSjJ",
                      "after": "QVFIUlZAPOEdrMVJ"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{catalog_id}/batch": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogId"
        }
      ],
      "post": {
        "tags": [
          "Catalog"
        ],
        "operationId": "batchProducts",
        "summary": "Create, update or delete products",
        "x-seo-description": "Create, update or delete products in your WhatsApp catalog in one batch request, using your own product IDs (SKUs).",
        "description": "Changes several products in one call. Each entry in `requests` has a `method` (`CREATE`, `UPDATE` or `DELETE`) and your product ID, `retailer_id`.\n\nThe changes are applied in the background, usually within a few minutes. Then [list products](/docs/whatsapp/catalog/list-products) to check.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductBatchRequest"
              },
              "examples": {
                "create": {
                  "summary": "Create a product",
                  "value": {
                    "requests": [
                      {
                        "method": "CREATE",
                        "retailer_id": "tshirt-blue-m",
                        "data": {
                          "name": "Blue T-shirt (M)",
                          "description": "100% cotton, regular fit.",
                          "price": 49900,
                          "currency": "INR",
                          "availability": "in stock",
                          "condition": "new",
                          "brand": "DoveMesh",
                          "category": "t-shirts",
                          "image_url": "https://example.com/images/tshirt-blue.jpg",
                          "url": "https://example.com/products/tshirt-blue",
                          "retailer_product_group_id": "tshirt-blue"
                        }
                      }
                    ]
                  }
                },
                "update": {
                  "summary": "Update price and stock",
                  "value": {
                    "requests": [
                      {
                        "method": "UPDATE",
                        "retailer_id": "tshirt-blue-m",
                        "data": {
                          "price": 44900,
                          "availability": "out of stock"
                        }
                      }
                    ]
                  }
                },
                "delete": {
                  "summary": "Delete a product",
                  "value": {
                    "requests": [
                      {
                        "method": "DELETE",
                        "retailer_id": "tshirt-blue-m"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The batch was accepted.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductBatchResult"
                },
                "example": {
                  "handles": [
                    "AczTnPmKBp2dM3Hc4Sji8HhOwP3xmZN_qWGR9jH2yPWfkkQsCn"
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{phone_number_id}/payments/{payment_configuration}/{reference_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        },
        {
          "name": "payment_configuration",
          "in": "path",
          "required": true,
          "description": "Name of your payment configuration in WhatsApp Manager.",
          "schema": {
            "type": "string",
            "example": "main-store"
          }
        },
        {
          "name": "reference_id",
          "in": "path",
          "required": true,
          "description": "Your order ID from the payment request.",
          "schema": {
            "type": "string",
            "example": "order-1042"
          }
        }
      ],
      "get": {
        "tags": [
          "Payments"
        ],
        "operationId": "retrievePayment",
        "summary": "Retrieve a payment",
        "x-seo-description": "Check whether a WhatsApp Payments request in India has been paid, using your order reference ID.",
        "description": "Returns whether a payment request has been paid. Always confirm the payment with your payment gateway before you deliver the order.",
        "responses": {
          "200": {
            "description": "The payment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentStatus"
                },
                "example": {
                  "payments": [
                    {
                      "reference_id": "order-1042",
                      "status": "CAPTURED",
                      "amount": {
                        "value": 104800,
                        "offset": 100
                      },
                      "currency": "INR"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{phone_number_id}/payments_refund": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        }
      ],
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "refundPayment",
        "summary": "Refund a payment",
        "x-seo-description": "Refund all or part of a payment a customer made inside WhatsApp in India.",
        "description": "Refunds all or part of a payment made inside WhatsApp. The refund starts as `pending`; your payment gateway completes it and returns the money to the customer.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RefundRequest"
              },
              "example": {
                "reference_id": "order-1042",
                "payment_config_id": "main-store",
                "speed": "normal",
                "amount": {
                  "currency": "INR",
                  "value": 49900,
                  "offset": 100
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The refund has started.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RefundResult"
                },
                "example": {
                  "id": "rfnd_OT3Mjhs8dhW2Ks",
                  "status": "pending",
                  "speed_processed": "normal"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/business/{phone_number_id}/message_qrdls": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        }
      ],
      "get": {
        "tags": [
          "QR codes"
        ],
        "operationId": "listQrCodes",
        "summary": "List QR codes",
        "x-seo-description": "List your WhatsApp QR codes and short links, with their prefilled messages and image links.",
        "description": "Returns your QR codes. To get one code, pass its `code`.\n\nImage links aren't included by default. To get them, add `qr_image_url.format(PNG)` or `qr_image_url.format(SVG)` to `fields`.\n",
        "parameters": [
          {
            "name": "code",
            "in": "query",
            "description": "Return only this QR code.",
            "schema": {
              "type": "string",
              "example": "RPASB5GEAP6FO1"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Comma-separated fields to return.",
            "schema": {
              "type": "string",
              "example": "code,prefilled_message,deep_link_url,qr_image_url.format(PNG)"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Your QR codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QrCodeList"
                },
                "example": {
                  "data": [
                    {
                      "code": "RPASB5GEAP6FO1",
                      "prefilled_message": "Hi, I'd like to know more about your hosting plans",
                      "deep_link_url": "https://wa.me/message/RPASB5GEAP6FO1",
                      "qr_image_url": "https://example.com/qr/RPASB5GEAP6FO1.png"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      },
      "post": {
        "tags": [
          "QR codes"
        ],
        "operationId": "saveQrCode",
        "summary": "Create or update a QR code",
        "x-seo-description": "Create a WhatsApp QR code and short link that opens a chat with a prefilled message, or change the message of an existing code.",
        "description": "Creates a QR code with a prefilled message. To **change** the message of an existing code, include its `code`; the QR image stays the same, so printed codes keep working.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QrCodeRequest"
              },
              "examples": {
                "create": {
                  "summary": "Create",
                  "value": {
                    "prefilled_message": "Hi, I'd like to know more about your hosting plans",
                    "generate_qr_image": "PNG"
                  }
                },
                "update": {
                  "summary": "Update",
                  "value": {
                    "code": "RPASB5GEAP6FO1",
                    "prefilled_message": "Hi, I'd like to know about your Diwali offers"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The QR code.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QrCode"
                },
                "example": {
                  "code": "RPASB5GEAP6FO1",
                  "prefilled_message": "Hi, I'd like to know more about your hosting plans",
                  "deep_link_url": "https://wa.me/message/RPASB5GEAP6FO1",
                  "qr_image_url": "https://example.com/qr/RPASB5GEAP6FO1.png"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/business/{phone_number_id}/message_qrdls/{code}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        },
        {
          "name": "code",
          "in": "path",
          "required": true,
          "description": "The QR code's ID.",
          "schema": {
            "type": "string",
            "example": "RPASB5GEAP6FO1"
          }
        }
      ],
      "delete": {
        "tags": [
          "QR codes"
        ],
        "operationId": "deleteQrCode",
        "summary": "Delete a QR code",
        "x-seo-description": "Delete a WhatsApp QR code and its short link with the API, so scanning it no longer opens a chat with your business.",
        "description": "Deletes a QR code. Printed copies and its short link stop opening the chat.",
        "responses": {
          "200": {
            "$ref": "#/components/responses/Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/flows/{phone_number_id}/set_whatsapp_business_encryption": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        }
      ],
      "post": {
        "tags": [
          "Flows"
        ],
        "operationId": "setFlowsEncryptionKey",
        "summary": "Set up the encryption key",
        "x-seo-description": "Set up the encryption key WhatsApp Flows use to exchange data securely with your server.",
        "description": "Sets up the encryption key that endpoint Flows use for this number. Do it once per number, then [retrieve the private key](/docs/whatsapp/flows/retrieve-flows-private-key) for your server. No request body is needed.",
        "responses": {
          "200": {
            "$ref": "#/components/responses/Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/flows/{phone_number_id}/get_private_key": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        }
      ],
      "get": {
        "tags": [
          "Flows"
        ],
        "operationId": "retrieveFlowsPrivateKey",
        "summary": "Retrieve the private key",
        "x-seo-description": "Get the private key your WhatsApp Flows endpoint uses to decrypt requests from WhatsApp.",
        "description": "Returns the private key your Flow endpoint uses to decrypt requests from WhatsApp. Store it like a password, in your server's secret storage, never in code.",
        "responses": {
          "200": {
            "description": "The private key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlowsPrivateKey"
                },
                "example": {
                  "result": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA4I6QAFQ7T8/bwuIDcAvjt5RFG+mHiZJUzNl4IPn5RE2F...\n-----END RSA PRIVATE KEY-----"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/getuserdetails": {
      "get": {
        "tags": [
          "Account"
        ],
        "operationId": "listPhoneNumbers",
        "summary": "List your phone numbers",
        "x-seo-description": "List the WhatsApp numbers your API key can use, with their phone number IDs and WhatsApp Business Account ID.",
        "description": "Returns the WhatsApp numbers your API key can use, with their `phone_number_id` and `waba_id`. It's a good first call to check that your key works.",
        "responses": {
          "200": {
            "description": "Your numbers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneNumberList"
                },
                "example": {
                  "code": 200,
                  "status": "SUCCESS",
                  "data": [
                    {
                      "whatsapp_business_account_id": "105954558954427",
                      "wanumber": "+919876500000",
                      "phone_number_id": "106540352242922"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    },
    "/{phone_number_id}/balance": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PhoneNumberId"
        }
      ],
      "get": {
        "tags": [
          "Account"
        ],
        "operationId": "retrieveBalance",
        "summary": "Retrieve your message credit balance",
        "x-seo-description": "Check a WhatsApp number's message credit balance with the API, in your wallet's currency, before sending a campaign.",
        "description": "Returns the message credit left on a number your key works for, in your wallet's currency (INR or USD). Each number has its own wallet; top it up on the dashboard on the number's **Credit** page.\n\nThe balance is refreshed at most once a minute, so polling faster returns the same value. `updated_at` says when it was last read.\n\nIt works even when the number's API plan has lapsed or the number is suspended, so you can always see what credit is left.\n",
        "responses": {
          "200": {
            "description": "The number's balance.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Balance"
                },
                "example": {
                  "phone_number_id": "106540352242922",
                  "currency": "INR",
                  "balance": {
                    "value": 153000,
                    "offset": 100
                  },
                  "updated_at": "2026-09-30T10:00:00.000Z",
                  "stale": false
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "description": "The number isn't one your key works for (`number_not_found`), or it has no message credit set up yet (`wallet_not_set_up`; contact DoveMesh support).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GatewayError"
                },
                "example": {
                  "error": "wallet_not_set_up",
                  "message": "This number has no message credit set up yet. Contact DoveMesh support."
                }
              }
            }
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          },
          "503": {
            "description": "DoveMesh couldn't look the balance up just then. Retry in a few seconds.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GatewayError"
                },
                "example": {
                  "error": "gateway_unavailable",
                  "message": "Try again in a few seconds."
                }
              }
            }
          }
        }
      }
    },
    "/{waba_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/WabaId"
        }
      ],
      "get": {
        "tags": [
          "Account"
        ],
        "operationId": "retrieveBusinessAccount",
        "summary": "Retrieve your business account",
        "x-seo-description": "Get your WhatsApp Business Account's name, currency, time zone and template namespace.",
        "description": "Returns details of your WhatsApp Business Account. Use `fields` to ask for specific fields, such as `message_template_namespace`.",
        "parameters": [
          {
            "name": "fields",
            "in": "query",
            "description": "Comma-separated fields to return. Leave it out to get the defaults.",
            "schema": {
              "type": "string",
              "example": "id,name,currency,timezone_id,message_template_namespace"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The account.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BusinessAccount"
                },
                "example": {
                  "id": "105954558954427",
                  "name": "DoveMesh Store",
                  "currency": "INR",
                  "timezone_id": "71",
                  "message_template_namespace": "13f5d10e_e4ed_4de3_8538_cd0b2a7918d4"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "502": {
            "$ref": "#/components/responses/UpstreamUnreachable"
          }
        }
      }
    }
  },
  "webhooks": {
    "incomingMessage": {
      "post": {
        "operationId": "incomingMessage",
        "summary": "Incoming message",
        "x-seo-description": "WhatsApp webhook for incoming messages: text, media, button and list replies, reactions, orders, locations and ad referrals, with examples.",
        "description": "Sent when a customer messages your number. This includes taps on your buttons and lists, reactions, orders and shared locations.\n\n- `messages[].type` says what kind of message it is, and the field with the same name holds the content.\n- `contacts[].profile.name` is the customer's WhatsApp name; `from` is their number (`wa_id`). Reply to it.\n- Files arrive as a media `id`. [Download them](/docs/whatsapp/media) promptly.\n- Each incoming message opens or restarts the customer's [24-hour window](/docs/whatsapp/messaging-window).\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IncomingMessageEvent"
              },
              "examples": {
                "text": {
                  "summary": "Text",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTFCMkMzRDRFNUY2",
                                  "timestamp": "1790505600",
                                  "type": "text",
                                  "text": {
                                    "body": "Is my order shipped yet?"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "image": {
                  "summary": "Image",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQzNFNTM2NjA5RTNG",
                                  "timestamp": "1790505620",
                                  "type": "image",
                                  "image": {
                                    "id": "1166846181421424",
                                    "mime_type": "image/jpeg",
                                    "sha256": "5AwgTLQdhdS/EBrNcrw7XbTYd6xx+RJqDamOf2EuJvA=",
                                    "caption": "This is the damaged box"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "button_reply": {
                  "summary": "Reply button tapped",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggRDc1QTBBRjQ2Q0Mz",
                                  "timestamp": "1790505640",
                                  "context": {
                                    "from": "919876500000",
                                    "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSQUJBNEU0QURBRTMx"
                                  },
                                  "type": "interactive",
                                  "interactive": {
                                    "type": "button_reply",
                                    "button_reply": {
                                      "id": "confirm_1042",
                                      "title": "Yes, confirm"
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "list_reply": {
                  "summary": "List item picked",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggN0ZDNTlEMkEyQUQ1",
                                  "timestamp": "1790505660",
                                  "context": {
                                    "from": "919876500000",
                                    "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSQUJBNEU0QURBRTMx"
                                  },
                                  "type": "interactive",
                                  "interactive": {
                                    "type": "list_reply",
                                    "list_reply": {
                                      "id": "plan_pro",
                                      "title": "Pro",
                                      "description": "10 websites, 50 GB storage"
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "template_button": {
                  "summary": "Template quick reply tapped",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggNUQ3QjI2RjE0MkZB",
                                  "timestamp": "1790505680",
                                  "context": {
                                    "from": "919876500000",
                                    "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSNzM0QkY3RURGMzhD"
                                  },
                                  "type": "button",
                                  "button": {
                                    "text": "Stop promotions",
                                    "payload": "unsubscribe_marketing"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "reaction": {
                  "summary": "Reaction",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggOEE3QzE5MDlGMjE2",
                                  "timestamp": "1790505700",
                                  "type": "reaction",
                                  "reaction": {
                                    "message_id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSNzM0QkY3RURGMzhD",
                                    "emoji": "👍"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "location": {
                  "summary": "Location shared",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggM0NFNTUyRURCRDA2",
                                  "timestamp": "1790505720",
                                  "type": "location",
                                  "location": {
                                    "latitude": 9.9252,
                                    "longitude": 78.1198
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "order": {
                  "summary": "Order from catalog",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggOTg3NjU0MzIxMEFC",
                                  "timestamp": "1790505740",
                                  "type": "order",
                                  "order": {
                                    "catalog_id": "801262455316921",
                                    "text": "Please deliver after 6pm",
                                    "product_items": [
                                      {
                                        "product_retailer_id": "tshirt-blue-m",
                                        "quantity": 2,
                                        "item_price": 499,
                                        "currency": "INR"
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "ad_referral": {
                  "summary": "From a click-to-WhatsApp ad",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "contacts": [
                                {
                                  "profile": {
                                    "name": "Priya Sharma"
                                  },
                                  "wa_id": "919876543210"
                                }
                              ],
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQUQxMjM0NTY3ODkw",
                                  "timestamp": "1790505760",
                                  "type": "text",
                                  "text": {
                                    "body": "Hi, I saw your Diwali offer"
                                  },
                                  "referral": {
                                    "source_url": "https://fb.me/example",
                                    "source_id": "120210000000000000",
                                    "source_type": "ad",
                                    "headline": "Diwali sale, 30% off",
                                    "body": "Tap to chat with us on WhatsApp",
                                    "media_type": "image",
                                    "image_url": "https://example.com/ads/diwali.jpg"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "changed_number": {
                  "summary": "Customer changed number",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "messages": [
                                {
                                  "from": "919876543210",
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggU1lTVEVNMTIzNDU2",
                                  "timestamp": "1790505780",
                                  "type": "system",
                                  "system": {
                                    "type": "user_changed_number",
                                    "body": "Priya Sharma changed from 919876543210 to 919812345678",
                                    "new_wa_id": "919812345678"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "messageStatus": {
      "post": {
        "operationId": "messageStatus",
        "summary": "Message status",
        "x-seo-description": "WhatsApp webhook for message statuses: sent, delivered, read and failed, with pricing details and error codes.",
        "description": "Sent each time one of your messages changes status: `sent`, then `delivered`, then `read`, or `failed`.\n\n- Match it to your message with `statuses[].id`, the ID you got when you sent the message.\n- Statuses can arrive out of order or more than once. Keep the latest by `timestamp`.\n- `pricing` shows whether WhatsApp charges for the message and in which category.\n- A `failed` status has an `errors` list. See [Errors](/docs/whatsapp/errors).\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MessageStatusEvent"
              },
              "examples": {
                "delivered": {
                  "summary": "Delivered",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "statuses": [
                                {
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSNzM0QkY3RURGMzhDQ0M1ODAA",
                                  "status": "delivered",
                                  "timestamp": "1790505600",
                                  "recipient_id": "919876543210",
                                  "pricing": {
                                    "billable": true,
                                    "pricing_model": "PMP",
                                    "category": "utility",
                                    "type": "regular"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "read": {
                  "summary": "Read",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "statuses": [
                                {
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSNzM0QkY3RURGMzhDQ0M1ODAA",
                                  "status": "read",
                                  "timestamp": "1790505660",
                                  "recipient_id": "919876543210"
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "failed": {
                  "summary": "Failed",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "changes": [
                          {
                            "field": "messages",
                            "value": {
                              "messaging_product": "whatsapp",
                              "metadata": {
                                "display_phone_number": "919876500000",
                                "phone_number_id": "106540352242922"
                              },
                              "statuses": [
                                {
                                  "id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSQzc3QUNGRDI2QjM4Q0RCQjNDAA",
                                  "status": "failed",
                                  "timestamp": "1790505600",
                                  "recipient_id": "919876543210",
                                  "errors": [
                                    {
                                      "code": 131047,
                                      "title": "Message failed to send because more than 24 hours have passed since the customer last replied to this number",
                                      "href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/"
                                    }
                                  ]
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "templateStatus": {
      "post": {
        "operationId": "templateStatus",
        "summary": "Template status",
        "x-seo-description": "WhatsApp webhook sent when a message template is approved, rejected, flagged, paused or disabled.",
        "description": "Sent when WhatsApp approves, rejects, flags, pauses or disables one of your templates.\n\n- On `REJECTED`, `reason` says why. Fix the template and [edit it](/docs/whatsapp/templates/update-template) to have it reviewed again.\n- `FLAGGED` is a warning: the template will be disabled on `disable_info.disable_date` unless its quality improves.\n- While a template is `PAUSED` or `DISABLED`, sending it fails. Use another template in the meantime.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TemplateStatusEvent"
              },
              "examples": {
                "approved": {
                  "summary": "Approved",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "message_template_status_update",
                            "value": {
                              "event": "APPROVED",
                              "message_template_id": 594425479261596,
                              "message_template_name": "order_shipped",
                              "message_template_language": "en",
                              "reason": "NONE"
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "rejected": {
                  "summary": "Rejected",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "message_template_status_update",
                            "value": {
                              "event": "REJECTED",
                              "message_template_id": 594425479261597,
                              "message_template_name": "diwali_offer",
                              "message_template_language": "en",
                              "reason": "INCORRECT_CATEGORY"
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "paused": {
                  "summary": "Paused",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "message_template_status_update",
                            "value": {
                              "event": "PAUSED",
                              "message_template_id": 594425479261598,
                              "message_template_name": "weekly_deals",
                              "message_template_language": "en",
                              "reason": "NONE",
                              "other_info": {
                                "title": "FIRST_PAUSE",
                                "description": "Your WhatsApp message template has been paused for 3 hours because it had issues."
                              }
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "flagged": {
                  "summary": "Flagged",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "message_template_status_update",
                            "value": {
                              "event": "FLAGGED",
                              "message_template_id": 594425479261598,
                              "message_template_name": "weekly_deals",
                              "message_template_language": "en",
                              "reason": null,
                              "disable_info": {
                                "disable_date": "October 3, 2026"
                              }
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "templateCategory": {
      "post": {
        "operationId": "templateCategory",
        "summary": "Template category changed",
        "x-seo-description": "WhatsApp webhook sent when WhatsApp moves one of your message templates to another category.",
        "description": "Sent when WhatsApp moves one of your templates to another category, for example from `UTILITY` to `MARKETING`. The category decides how the template is priced.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TemplateCategoryEvent"
              },
              "examples": {
                "changed": {
                  "summary": "Category changed",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "template_category_update",
                            "value": {
                              "message_template_id": 594425479261596,
                              "message_template_name": "order_shipped",
                              "message_template_language": "en",
                              "previous_category": "UTILITY",
                              "new_category": "MARKETING"
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "templateQuality": {
      "post": {
        "operationId": "templateQuality",
        "summary": "Template quality changed",
        "x-seo-description": "WhatsApp webhook sent when a message template's quality rating changes.",
        "description": "Sent when a template's quality rating changes. The rating reflects how customers react: blocks and reports lower it. A template that stays `RED` is paused and can be disabled.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TemplateQualityEvent"
              },
              "examples": {
                "dropped": {
                  "summary": "Quality dropped",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "message_template_quality_update",
                            "value": {
                              "previous_quality_score": "GREEN",
                              "new_quality_score": "YELLOW",
                              "message_template_id": 594425479261598,
                              "message_template_name": "weekly_deals",
                              "message_template_language": "en"
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "phoneNumberName": {
      "post": {
        "operationId": "phoneNumberName",
        "summary": "Display name reviewed",
        "x-seo-description": "WhatsApp webhook sent when your number's display name is approved or rejected.",
        "description": "Sent when WhatsApp approves or rejects the display name you asked for on your number.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PhoneNumberNameEvent"
              },
              "examples": {
                "approved": {
                  "summary": "Approved",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "phone_number_name_update",
                            "value": {
                              "display_phone_number": "919876500000",
                              "decision": "APPROVED",
                              "requested_verified_name": "DoveMesh Store",
                              "rejection_reason": null
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "phoneNumberQuality": {
      "post": {
        "operationId": "phoneNumberQuality",
        "summary": "Number quality and limit changed",
        "x-seo-description": "WhatsApp webhook sent when your number's quality rating or daily messaging limit changes.",
        "description": "Sent when your number's quality rating or messaging limit changes. The messaging limit is how many different customers you can start conversations with in 24 hours. See [Rate limits](/docs/whatsapp/rate-limits).\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PhoneNumberQualityEvent"
              },
              "examples": {
                "upgrade": {
                  "summary": "Limit raised",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "phone_number_quality_update",
                            "value": {
                              "display_phone_number": "919876500000",
                              "event": "UPGRADE",
                              "current_limit": "TIER_10K"
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "flagged": {
                  "summary": "Quality flagged",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "phone_number_quality_update",
                            "value": {
                              "display_phone_number": "919876500000",
                              "event": "FLAGGED",
                              "current_limit": "TIER_1K"
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "accountUpdate": {
      "post": {
        "operationId": "accountUpdate",
        "summary": "Account updated",
        "x-seo-description": "WhatsApp webhook for account changes: verification, policy violations, restrictions and bans.",
        "description": "Sent when something important changes on your WhatsApp Business Account: verification, policy violations, restrictions and bans. Restrictions and bans stop some or all sending, so alert your team and contact DoveMesh support.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateEvent"
              },
              "examples": {
                "restriction": {
                  "summary": "Restricted",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "account_update",
                            "value": {
                              "event": "ACCOUNT_RESTRICTION",
                              "restriction_info": [
                                {
                                  "restriction_type": "RESTRICTED_BIZ_INITIATED_MESSAGING",
                                  "expiration": 1790937600
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "violation": {
                  "summary": "Policy violation",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "account_update",
                            "value": {
                              "event": "ACCOUNT_VIOLATION",
                              "violation_info": {
                                "violation_type": "SCAM"
                              }
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "verified": {
                  "summary": "Number verified",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "account_update",
                            "value": {
                              "phone_number": "919876500000",
                              "event": "VERIFIED_ACCOUNT"
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "accountAlerts": {
      "post": {
        "operationId": "accountAlerts",
        "summary": "Account alert",
        "x-seo-description": "WhatsApp webhook for account alerts, such as a declined request to raise your messaging limit.",
        "description": "Sent when WhatsApp has news about your account's limits, such as a declined request to raise your messaging limit. `alert_description` explains what to do.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountAlertEvent"
              },
              "examples": {
                "deferred": {
                  "summary": "Limit increase deferred",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "account_alerts",
                            "value": {
                              "entity_type": "BUSINESS",
                              "entity_id": "2329417887457253",
                              "alert_severity": "WARNING",
                              "alert_status": "ACTIVE",
                              "alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_DEFERRED",
                              "alert_description": "Limits cannot be increased for your business. Use WhatsApp Business platform actively for several days and follow our messaging policies."
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "accountReview": {
      "post": {
        "operationId": "accountReview",
        "summary": "Account reviewed",
        "x-seo-description": "WhatsApp webhook sent when WhatsApp finishes reviewing your WhatsApp Business Account.",
        "description": "Sent when WhatsApp finishes reviewing your WhatsApp Business Account.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountReviewEvent"
              },
              "examples": {
                "approved": {
                  "summary": "Approved",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "account_review_update",
                            "value": {
                              "decision": "APPROVED"
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    },
    "businessCapability": {
      "post": {
        "operationId": "businessCapability",
        "summary": "Business limits changed",
        "x-seo-description": "WhatsApp webhook sent when your business's messaging limit or number limit changes.",
        "description": "Sent when your business's limits change: the messaging limit for your numbers, or how many numbers you can have.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/SignatureHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BusinessCapabilityEvent"
              },
              "examples": {
                "changed": {
                  "summary": "Limits changed",
                  "value": {
                    "object": "whatsapp_business_account",
                    "entry": [
                      {
                        "id": "105954558954427",
                        "time": 1790505600,
                        "changes": [
                          {
                            "field": "business_capability_update",
                            "value": {
                              "max_daily_conversation_per_phone": 10000,
                              "max_phone_numbers_per_business": 2
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/WebhookReceived"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "apikey",
        "description": "Your DoveMesh API key, from the dashboard's **Developers** page."
      }
    },
    "parameters": {
      "PhoneNumberId": {
        "name": "phone_number_id",
        "in": "path",
        "required": true,
        "description": "ID of your WhatsApp number, from the dashboard or [List your phone numbers](/docs/whatsapp/account/list-phone-numbers). It isn't the phone number itself.",
        "schema": {
          "type": "string",
          "example": "106540352242922"
        }
      },
      "MediaId": {
        "name": "media_id",
        "in": "path",
        "required": true,
        "description": "ID of the file, from [Upload media](/docs/whatsapp/media/upload-media) or an incoming message webhook.",
        "schema": {
          "type": "string",
          "example": "1166846181421424"
        }
      },
      "MediaPhoneNumberQuery": {
        "name": "phone_number_id",
        "in": "query",
        "required": true,
        "description": "ID of your WhatsApp number that uploaded or received the file.",
        "schema": {
          "type": "string",
          "example": "106540352242922"
        }
      },
      "WabaId": {
        "name": "waba_id",
        "in": "path",
        "required": true,
        "description": "ID of your WhatsApp Business Account (`whatsapp_business_account_id` in [List your phone numbers](/docs/whatsapp/account/list-phone-numbers)).",
        "schema": {
          "type": "string",
          "example": "105954558954427"
        }
      },
      "TemplateId": {
        "name": "template_id",
        "in": "path",
        "required": true,
        "description": "ID of the template, returned when you create or list templates.",
        "schema": {
          "type": "string",
          "example": "594425479261596"
        }
      },
      "CatalogId": {
        "name": "catalog_id",
        "in": "path",
        "required": true,
        "description": "ID of your product catalog, from [Retrieve your catalog ID](/docs/whatsapp/catalog/retrieve-catalog-id).",
        "schema": {
          "type": "string",
          "example": "801262455316921"
        }
      },
      "SignatureHeader": {
        "name": "X-DoveMesh-Signature",
        "in": "header",
        "required": true,
        "description": "Proves the request came from DoveMesh. `t` is the send time and `v1` an HMAC-SHA256 of `t`, a full stop and the raw body, signed with your signing secret. See [Check the signature](/docs/whatsapp/webhooks#check-the-signature).",
        "schema": {
          "type": "string",
          "example": "t=1727430000,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd"
        }
      }
    },
    "schemas": {
      "MessageBase": {
        "type": "object",
        "required": [
          "messaging_product",
          "to"
        ],
        "properties": {
          "messaging_product": {
            "type": "string",
            "const": "whatsapp",
            "description": "Always `whatsapp`."
          },
          "recipient_type": {
            "type": "string",
            "const": "individual",
            "default": "individual",
            "description": "Always `individual`."
          },
          "to": {
            "type": "string",
            "description": "The customer's phone number with country code, digits only, such as `919876543210`. A `wa_id` from a webhook also works."
          },
          "context": {
            "type": "object",
            "description": "Send this message as a reply. WhatsApp shows it with a quote of the earlier message.",
            "required": [
              "message_id"
            ],
            "properties": {
              "message_id": {
                "type": "string",
                "description": "ID of the message you're replying to."
              }
            }
          }
        }
      },
      "TextMessage": {
        "title": "Text",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "text"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "text"
              },
              "text": {
                "type": "object",
                "required": [
                  "body"
                ],
                "properties": {
                  "body": {
                    "type": "string",
                    "maxLength": 4096,
                    "description": "The message text. Supports WhatsApp formatting such as `*bold*` and `_italic_`."
                  },
                  "preview_url": {
                    "type": "boolean",
                    "default": false,
                    "description": "Show a preview of the first link in `body`."
                  }
                }
              }
            }
          }
        ]
      },
      "MediaByLink": {
        "title": "By link",
        "type": "object",
        "required": [
          "link"
        ],
        "properties": {
          "link": {
            "type": "string",
            "format": "uri",
            "description": "Public HTTPS URL of the file. WhatsApp downloads it when sending, so it must work without a login."
          }
        }
      },
      "MediaById": {
        "title": "By uploaded file",
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Media ID from [Upload media](/docs/whatsapp/media/upload-media)."
          }
        }
      },
      "Media": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/MediaByLink"
          },
          {
            "$ref": "#/components/schemas/MediaById"
          }
        ]
      },
      "Location": {
        "type": "object",
        "required": [
          "latitude",
          "longitude"
        ],
        "properties": {
          "latitude": {
            "type": "number",
            "minimum": -90,
            "maximum": 90,
            "description": "Latitude in decimal degrees."
          },
          "longitude": {
            "type": "number",
            "minimum": -180,
            "maximum": 180,
            "description": "Longitude in decimal degrees."
          },
          "name": {
            "type": "string",
            "description": "Name of the place."
          },
          "address": {
            "type": "string",
            "description": "Address shown under the name."
          }
        }
      },
      "ProductSection": {
        "type": "object",
        "required": [
          "title",
          "product_items"
        ],
        "properties": {
          "title": {
            "type": "string",
            "maxLength": 24
          },
          "product_items": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "object",
              "required": [
                "product_retailer_id"
              ],
              "properties": {
                "product_retailer_id": {
                  "type": "string",
                  "description": "Your ID (SKU) for the product."
                }
              }
            }
          }
        }
      },
      "TemplateParameter": {
        "oneOf": [
          {
            "title": "Text",
            "type": "object",
            "required": [
              "type",
              "text"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "text"
              },
              "text": {
                "type": "string",
                "description": "Replaces a `{{…}}` placeholder. For a website button, the part of the link that replaces its placeholder."
              },
              "parameter_name": {
                "type": "string",
                "description": "Named templates only: the placeholder this value fills, without braces, such as `first_name`. Values can then come in any order."
              }
            }
          },
          {
            "title": "Currency",
            "type": "object",
            "required": [
              "type",
              "currency"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "currency"
              },
              "currency": {
                "type": "object",
                "required": [
                  "fallback_value",
                  "code",
                  "amount_1000"
                ],
                "properties": {
                  "fallback_value": {
                    "type": "string",
                    "description": "The amount as text, such as `₹1,499.00`."
                  },
                  "code": {
                    "type": "string",
                    "description": "Currency code, such as `INR`."
                  },
                  "amount_1000": {
                    "type": "integer",
                    "description": "The amount times 1000. ₹1,499.00 is `1499000`."
                  }
                }
              }
            }
          },
          {
            "title": "Date and time",
            "type": "object",
            "required": [
              "type",
              "date_time"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "date_time"
              },
              "date_time": {
                "type": "object",
                "required": [
                  "fallback_value"
                ],
                "properties": {
                  "fallback_value": {
                    "type": "string",
                    "description": "The date and time as text, such as `Friday, 3 October 2026, 4:00 PM`."
                  }
                }
              }
            }
          },
          {
            "title": "Image",
            "type": "object",
            "required": [
              "type",
              "image"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "image"
              },
              "image": {
                "$ref": "#/components/schemas/Media"
              }
            }
          },
          {
            "title": "Video",
            "type": "object",
            "required": [
              "type",
              "video"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "video"
              },
              "video": {
                "$ref": "#/components/schemas/Media"
              }
            }
          },
          {
            "title": "Document",
            "type": "object",
            "required": [
              "type",
              "document"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "document"
              },
              "document": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Media"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "filename": {
                        "type": "string"
                      }
                    }
                  }
                ]
              }
            }
          },
          {
            "title": "Location",
            "type": "object",
            "required": [
              "type",
              "location"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "location"
              },
              "location": {
                "$ref": "#/components/schemas/Location"
              }
            }
          },
          {
            "title": "Quick reply payload",
            "type": "object",
            "required": [
              "type",
              "payload"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "payload"
              },
              "payload": {
                "type": "string",
                "description": "Sent back to you (as `button.payload`) when the customer taps this quick reply."
              }
            }
          },
          {
            "title": "Coupon code",
            "type": "object",
            "required": [
              "type",
              "coupon_code"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "coupon_code"
              },
              "coupon_code": {
                "type": "string",
                "maxLength": 15,
                "description": "The code the customer copies with the copy-code button."
              }
            }
          },
          {
            "title": "Limited-time offer",
            "type": "object",
            "required": [
              "type",
              "limited_time_offer"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "limited_time_offer"
              },
              "limited_time_offer": {
                "type": "object",
                "required": [
                  "expiration_time_ms"
                ],
                "properties": {
                  "expiration_time_ms": {
                    "type": "integer",
                    "description": "When the offer ends, as a Unix timestamp in milliseconds."
                  }
                }
              }
            }
          },
          {
            "title": "Catalog or multi-product action",
            "type": "object",
            "required": [
              "type",
              "action"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "action"
              },
              "action": {
                "type": "object",
                "properties": {
                  "thumbnail_product_retailer_id": {
                    "type": "string",
                    "description": "Your ID (SKU) of the product whose image is shown on the message. Required for multi-product templates. Optional for catalog templates: leave it out, or leave out the button's `parameters`, and the image of the first item in your catalog is shown."
                  },
                  "sections": {
                    "type": "array",
                    "description": "Multi-product templates only: the products to show, in up to 10 sections.",
                    "items": {
                      "$ref": "#/components/schemas/ProductSection"
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "TemplateSendComponent": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "header",
              "body",
              "button",
              "carousel",
              "limited_time_offer"
            ],
            "description": "The part of the template these values fill."
          },
          "sub_type": {
            "type": "string",
            "enum": [
              "quick_reply",
              "url",
              "copy_code",
              "catalog",
              "mpm"
            ],
            "description": "Buttons only: the kind of button."
          },
          "index": {
            "type": [
              "string",
              "integer"
            ],
            "description": "Buttons only: the button's position among the template's buttons, starting at `0`."
          },
          "parameters": {
            "type": "array",
            "description": "One value per placeholder, in order. For a media header, the file.",
            "items": {
              "$ref": "#/components/schemas/TemplateParameter"
            }
          },
          "cards": {
            "type": "array",
            "description": "Carousels only: values for each card.",
            "items": {
              "type": "object",
              "required": [
                "card_index",
                "components"
              ],
              "properties": {
                "card_index": {
                  "type": "integer",
                  "description": "Position of the card, starting at `0`."
                },
                "components": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TemplateSendComponent"
                  }
                }
              }
            }
          }
        }
      },
      "TemplateMessage": {
        "title": "Template",
        "description": "A message format that WhatsApp approved in advance. The only type you can send outside the 24-hour window.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "template"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "template"
              },
              "template": {
                "type": "object",
                "required": [
                  "name",
                  "language"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The template's name."
                  },
                  "language": {
                    "type": "object",
                    "required": [
                      "code"
                    ],
                    "properties": {
                      "code": {
                        "type": "string",
                        "description": "Language the template was approved in, such as `en`, `en_US` or `hi`."
                      }
                    }
                  },
                  "components": {
                    "type": "array",
                    "description": "Values for the template's placeholders, media and buttons. Leave it out if the template has none.",
                    "items": {
                      "$ref": "#/components/schemas/TemplateSendComponent"
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "Caption": {
        "type": "object",
        "properties": {
          "caption": {
            "type": "string",
            "maxLength": 1024,
            "description": "Text shown under the file."
          }
        }
      },
      "ImageMessage": {
        "title": "Image",
        "description": "JPEG or PNG, up to 5 MB.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "image"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "image"
              },
              "image": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Media"
                  },
                  {
                    "$ref": "#/components/schemas/Caption"
                  }
                ]
              }
            }
          }
        ]
      },
      "VideoMessage": {
        "title": "Video",
        "description": "MP4 or 3GPP (H.264 video, AAC audio), up to 16 MB.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "video"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "video"
              },
              "video": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Media"
                  },
                  {
                    "$ref": "#/components/schemas/Caption"
                  }
                ]
              }
            }
          }
        ]
      },
      "AudioMessage": {
        "title": "Audio",
        "description": "AAC, AMR, MP3, M4A or OGG (Opus), up to 16 MB. Audio has no caption.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "audio"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "audio"
              },
              "audio": {
                "$ref": "#/components/schemas/Media"
              }
            }
          }
        ]
      },
      "DocumentMessage": {
        "title": "Document",
        "description": "PDF, Word, Excel, PowerPoint or plain text, up to 100 MB.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "document"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "document"
              },
              "document": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Media"
                  },
                  {
                    "$ref": "#/components/schemas/Caption"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "filename": {
                        "type": "string",
                        "description": "File name shown to the customer, with its extension."
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      },
      "StickerMessage": {
        "title": "Sticker",
        "description": "WebP, 512×512 pixels. Up to 100 KB, or 500 KB if animated.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "sticker"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "sticker"
              },
              "sticker": {
                "$ref": "#/components/schemas/Media"
              }
            }
          }
        ]
      },
      "LocationMessage": {
        "title": "Location",
        "description": "A map pin.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "location"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "location"
              },
              "location": {
                "$ref": "#/components/schemas/Location"
              }
            }
          }
        ]
      },
      "Contact": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "object",
            "required": [
              "formatted_name"
            ],
            "description": "Include `formatted_name` and at least one other part of the name.",
            "properties": {
              "formatted_name": {
                "type": "string",
                "description": "Full name as it should be shown."
              },
              "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",
                  "description": "Phone number with country code."
                },
                "type": {
                  "type": "string",
                  "description": "A label such as `CELL`, `MAIN`, `HOME` or `WORK`."
                },
                "wa_id": {
                  "type": "string",
                  "description": "WhatsApp ID. Adds a **Message** button to the card."
                }
              }
            }
          },
          "emails": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "format": "email"
                },
                "type": {
                  "type": "string",
                  "description": "`HOME` or `WORK`."
                }
              }
            }
          },
          "addresses": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "street": {
                  "type": "string"
                },
                "city": {
                  "type": "string"
                },
                "state": {
                  "type": "string"
                },
                "zip": {
                  "type": "string"
                },
                "country": {
                  "type": "string"
                },
                "country_code": {
                  "type": "string",
                  "description": "Two-letter country code, such as `IN`."
                },
                "type": {
                  "type": "string",
                  "description": "`HOME` or `WORK`."
                }
              }
            }
          },
          "org": {
            "type": "object",
            "properties": {
              "company": {
                "type": "string"
              },
              "department": {
                "type": "string"
              },
              "title": {
                "type": "string"
              }
            }
          },
          "urls": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "type": {
                  "type": "string",
                  "description": "`HOME` or `WORK`."
                }
              }
            }
          },
          "birthday": {
            "type": "string",
            "format": "date",
            "description": "Date of birth as `YYYY-MM-DD`."
          }
        }
      },
      "ContactsMessage": {
        "title": "Contacts",
        "description": "One or more contact cards the customer can save.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "contacts"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "contacts"
              },
              "contacts": {
                "type": "array",
                "minItems": 1,
                "items": {
                  "$ref": "#/components/schemas/Contact"
                }
              }
            }
          }
        ]
      },
      "Body": {
        "type": "object",
        "required": [
          "text"
        ],
        "properties": {
          "text": {
            "type": "string",
            "maxLength": 1024,
            "description": "Main text. Supports emoji, formatting and links."
          }
        }
      },
      "Footer": {
        "type": "object",
        "required": [
          "text"
        ],
        "properties": {
          "text": {
            "type": "string",
            "maxLength": 60,
            "description": "Small grey text under the body."
          }
        }
      },
      "ReplyButtons": {
        "title": "Reply buttons",
        "type": "object",
        "description": "Up to three buttons. When the customer taps one, you receive an incoming message with its `id` (`interactive.button_reply`).",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "button"
          },
          "header": {
            "type": "object",
            "description": "Optional header. Text, or an image, video or document.",
            "required": [
              "type"
            ],
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "text",
                  "image",
                  "video",
                  "document"
                ]
              },
              "text": {
                "type": "string",
                "maxLength": 60
              },
              "image": {
                "$ref": "#/components/schemas/Media"
              },
              "video": {
                "$ref": "#/components/schemas/Media"
              },
              "document": {
                "$ref": "#/components/schemas/Media"
              }
            }
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "footer": {
            "$ref": "#/components/schemas/Footer"
          },
          "action": {
            "type": "object",
            "required": [
              "buttons"
            ],
            "properties": {
              "buttons": {
                "type": "array",
                "minItems": 1,
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "required": [
                    "type",
                    "reply"
                  ],
                  "properties": {
                    "type": {
                      "type": "string",
                      "const": "reply"
                    },
                    "reply": {
                      "type": "object",
                      "required": [
                        "id",
                        "title"
                      ],
                      "properties": {
                        "id": {
                          "type": "string",
                          "maxLength": 256,
                          "description": "Your identifier for this choice, sent back when it's tapped. Unique within the message."
                        },
                        "title": {
                          "type": "string",
                          "maxLength": 20,
                          "description": "Button label. Unique within the message; no emoji or formatting."
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "TextHeader": {
        "type": "object",
        "required": [
          "type",
          "text"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "text"
          },
          "text": {
            "type": "string",
            "maxLength": 60,
            "description": "Header text. Emoji allowed, formatting isn't."
          }
        }
      },
      "ListMessage": {
        "title": "List",
        "type": "object",
        "description": "A button that opens a menu of up to 10 choices, grouped in sections. When the customer picks one, you receive an incoming message with its `id` (`interactive.list_reply`).",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "list"
          },
          "header": {
            "$ref": "#/components/schemas/TextHeader"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "footer": {
            "$ref": "#/components/schemas/Footer"
          },
          "action": {
            "type": "object",
            "required": [
              "button",
              "sections"
            ],
            "properties": {
              "button": {
                "type": "string",
                "maxLength": 20,
                "description": "Label of the button that opens the list."
              },
              "sections": {
                "type": "array",
                "minItems": 1,
                "maxItems": 10,
                "description": "Up to 10 rows in total across all sections.",
                "items": {
                  "type": "object",
                  "required": [
                    "rows"
                  ],
                  "properties": {
                    "title": {
                      "type": "string",
                      "maxLength": 24,
                      "description": "Section heading. Required when there's more than one section."
                    },
                    "rows": {
                      "type": "array",
                      "minItems": 1,
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "title"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "maxLength": 200,
                            "description": "Your identifier for this choice, sent back when it's picked."
                          },
                          "title": {
                            "type": "string",
                            "maxLength": 24
                          },
                          "description": {
                            "type": "string",
                            "maxLength": 72
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "LinkButton": {
        "title": "Link button",
        "type": "object",
        "description": "One button that opens a web page, so the link doesn't have to appear in the text.",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "cta_url"
          },
          "header": {
            "$ref": "#/components/schemas/TextHeader"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "footer": {
            "$ref": "#/components/schemas/Footer"
          },
          "action": {
            "type": "object",
            "required": [
              "name",
              "parameters"
            ],
            "properties": {
              "name": {
                "type": "string",
                "const": "cta_url"
              },
              "parameters": {
                "type": "object",
                "required": [
                  "display_text",
                  "url"
                ],
                "properties": {
                  "display_text": {
                    "type": "string",
                    "maxLength": 20,
                    "description": "Button label."
                  },
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "Address the button opens."
                  }
                }
              }
            }
          }
        }
      },
      "LocationRequest": {
        "title": "Location request",
        "type": "object",
        "description": "Shows a **Send location** button. The customer's location arrives as an incoming `location` message.",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "location_request_message"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "action": {
            "type": "object",
            "required": [
              "name"
            ],
            "properties": {
              "name": {
                "type": "string",
                "const": "send_location"
              }
            }
          }
        }
      },
      "AddressRequest": {
        "title": "Address request",
        "type": "object",
        "description": "Opens a form where the customer fills in a delivery address. Available for customers in India and Singapore. The address arrives as an incoming message of type `interactive`.\n\nFields in the Indian form: name, phone number, PIN code, flat or house number, floor, tower, building, address, landmark or area, city and state.\n",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "address_message"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "action": {
            "type": "object",
            "required": [
              "name",
              "parameters"
            ],
            "properties": {
              "name": {
                "type": "string",
                "const": "address_message"
              },
              "parameters": {
                "type": "object",
                "required": [
                  "country"
                ],
                "properties": {
                  "country": {
                    "type": "string",
                    "enum": [
                      "IN",
                      "SG"
                    ],
                    "description": "Country of the address form."
                  }
                }
              }
            }
          }
        }
      },
      "SingleProduct": {
        "title": "Single product",
        "type": "object",
        "description": "One product from your [catalog](/docs/whatsapp/catalog), with a **View** button.",
        "required": [
          "type",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "product"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "footer": {
            "$ref": "#/components/schemas/Footer"
          },
          "action": {
            "type": "object",
            "required": [
              "catalog_id",
              "product_retailer_id"
            ],
            "properties": {
              "catalog_id": {
                "type": "string",
                "description": "Your catalog ID."
              },
              "product_retailer_id": {
                "type": "string",
                "description": "Your ID (SKU) for the product."
              }
            }
          }
        }
      },
      "ProductList": {
        "title": "Product list",
        "type": "object",
        "description": "Up to 30 products from your catalog, in up to 10 sections.",
        "required": [
          "type",
          "header",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "product_list"
          },
          "header": {
            "$ref": "#/components/schemas/TextHeader"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "footer": {
            "$ref": "#/components/schemas/Footer"
          },
          "action": {
            "type": "object",
            "required": [
              "catalog_id",
              "sections"
            ],
            "properties": {
              "catalog_id": {
                "type": "string"
              },
              "sections": {
                "type": "array",
                "minItems": 1,
                "maxItems": 10,
                "items": {
                  "$ref": "#/components/schemas/ProductSection"
                }
              }
            }
          }
        }
      },
      "Carousel": {
        "title": "Carousel",
        "type": "object",
        "description": "Up to 10 swipeable cards. Each card is either an image or video with a link button, or a product from your catalog. All cards in one message must be the same kind.",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "carousel"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "action": {
            "type": "object",
            "required": [
              "cards"
            ],
            "properties": {
              "cards": {
                "type": "array",
                "minItems": 1,
                "maxItems": 10,
                "items": {
                  "oneOf": [
                    {
                      "title": "Link card",
                      "type": "object",
                      "required": [
                        "card_index",
                        "type",
                        "header",
                        "action"
                      ],
                      "properties": {
                        "card_index": {
                          "type": "integer",
                          "description": "Position of the card, starting at `0`."
                        },
                        "type": {
                          "type": "string",
                          "const": "cta_url"
                        },
                        "header": {
                          "type": "object",
                          "required": [
                            "type"
                          ],
                          "properties": {
                            "type": {
                              "type": "string",
                              "enum": [
                                "image",
                                "video"
                              ]
                            },
                            "image": {
                              "$ref": "#/components/schemas/Media"
                            },
                            "video": {
                              "$ref": "#/components/schemas/Media"
                            }
                          }
                        },
                        "body": {
                          "$ref": "#/components/schemas/Body"
                        },
                        "action": {
                          "type": "object",
                          "required": [
                            "name",
                            "parameters"
                          ],
                          "properties": {
                            "name": {
                              "type": "string",
                              "const": "cta_url"
                            },
                            "parameters": {
                              "type": "object",
                              "required": [
                                "display_text",
                                "url"
                              ],
                              "properties": {
                                "display_text": {
                                  "type": "string",
                                  "maxLength": 20
                                },
                                "url": {
                                  "type": "string",
                                  "format": "uri"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "title": "Product card",
                      "type": "object",
                      "required": [
                        "card_index",
                        "type",
                        "action"
                      ],
                      "properties": {
                        "card_index": {
                          "type": "integer"
                        },
                        "type": {
                          "type": "string",
                          "const": "product"
                        },
                        "action": {
                          "type": "object",
                          "required": [
                            "catalog_id",
                            "product_retailer_id"
                          ],
                          "properties": {
                            "catalog_id": {
                              "type": "string"
                            },
                            "product_retailer_id": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "Amount": {
        "type": "object",
        "description": "An amount of money. The real amount is `value ÷ offset`, so ₹499.00 is `{ \"value\": 49900, \"offset\": 100 }`.\n",
        "required": [
          "value",
          "offset"
        ],
        "properties": {
          "value": {
            "type": "integer",
            "description": "The amount times `offset`."
          },
          "offset": {
            "type": "integer",
            "const": 100,
            "description": "Always `100`."
          }
        }
      },
      "OrderDetails": {
        "title": "Payment request (order details)",
        "type": "object",
        "description": "Asks the customer to pay for an order inside WhatsApp (India only). See [Payments](/docs/whatsapp/payments).",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "order_details"
          },
          "header": {
            "type": "object",
            "description": "Optional image header.",
            "properties": {
              "type": {
                "type": "string",
                "const": "image"
              },
              "image": {
                "$ref": "#/components/schemas/Media"
              }
            }
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "footer": {
            "$ref": "#/components/schemas/Footer"
          },
          "action": {
            "type": "object",
            "required": [
              "name",
              "parameters"
            ],
            "properties": {
              "name": {
                "type": "string",
                "const": "review_and_pay"
              },
              "parameters": {
                "type": "object",
                "required": [
                  "reference_id",
                  "type",
                  "currency",
                  "total_amount",
                  "payment_settings",
                  "order"
                ],
                "properties": {
                  "reference_id": {
                    "type": "string",
                    "description": "Your unique ID for this order. You use it to check and refund the payment."
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "digital-goods",
                      "physical-goods"
                    ]
                  },
                  "currency": {
                    "type": "string",
                    "const": "INR"
                  },
                  "total_amount": {
                    "$ref": "#/components/schemas/Amount"
                  },
                  "payment_settings": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "type",
                        "payment_gateway"
                      ],
                      "properties": {
                        "type": {
                          "type": "string",
                          "const": "payment_gateway"
                        },
                        "payment_gateway": {
                          "type": "object",
                          "required": [
                            "type",
                            "configuration_name"
                          ],
                          "properties": {
                            "type": {
                              "type": "string",
                              "enum": [
                                "razorpay",
                                "payu"
                              ],
                              "description": "Your payment gateway."
                            },
                            "configuration_name": {
                              "type": "string",
                              "description": "Name of your payment configuration in WhatsApp Manager."
                            }
                          }
                        }
                      }
                    }
                  },
                  "order": {
                    "type": "object",
                    "required": [
                      "status",
                      "items",
                      "subtotal"
                    ],
                    "properties": {
                      "status": {
                        "type": "string",
                        "const": "pending"
                      },
                      "items": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "required": [
                            "retailer_id",
                            "name",
                            "amount",
                            "quantity"
                          ],
                          "properties": {
                            "retailer_id": {
                              "type": "string",
                              "description": "Your ID (SKU) for the item."
                            },
                            "product_id": {
                              "type": "string",
                              "description": "Catalog product ID, if the item is in your catalog."
                            },
                            "name": {
                              "type": "string"
                            },
                            "amount": {
                              "$ref": "#/components/schemas/Amount"
                            },
                            "quantity": {
                              "type": "integer",
                              "minimum": 1
                            }
                          }
                        }
                      },
                      "subtotal": {
                        "$ref": "#/components/schemas/Amount"
                      },
                      "tax": {
                        "$ref": "#/components/schemas/Amount"
                      },
                      "shipping": {
                        "$ref": "#/components/schemas/Amount"
                      },
                      "discount": {
                        "$ref": "#/components/schemas/Amount"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "OrderStatus": {
        "title": "Order status",
        "type": "object",
        "description": "Tells the customer what happened to an order they paid for, or cancels it.",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "order_status"
          },
          "body": {
            "$ref": "#/components/schemas/Body"
          },
          "action": {
            "type": "object",
            "required": [
              "name",
              "parameters"
            ],
            "properties": {
              "name": {
                "type": "string",
                "const": "review_order"
              },
              "parameters": {
                "type": "object",
                "required": [
                  "reference_id",
                  "order"
                ],
                "properties": {
                  "reference_id": {
                    "type": "string",
                    "description": "The `reference_id` of the payment request."
                  },
                  "order": {
                    "type": "object",
                    "required": [
                      "status"
                    ],
                    "properties": {
                      "status": {
                        "type": "string",
                        "enum": [
                          "completed",
                          "canceled"
                        ]
                      },
                      "description": {
                        "type": "string",
                        "description": "Optional note shown to the customer, such as a cancellation reason."
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "InteractiveMessage": {
        "title": "Interactive",
        "description": "A message the customer answers by tapping. Only inside the 24-hour window.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "interactive"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "interactive"
              },
              "interactive": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/ReplyButtons"
                  },
                  {
                    "$ref": "#/components/schemas/ListMessage"
                  },
                  {
                    "$ref": "#/components/schemas/LinkButton"
                  },
                  {
                    "$ref": "#/components/schemas/LocationRequest"
                  },
                  {
                    "$ref": "#/components/schemas/AddressRequest"
                  },
                  {
                    "$ref": "#/components/schemas/SingleProduct"
                  },
                  {
                    "$ref": "#/components/schemas/ProductList"
                  },
                  {
                    "$ref": "#/components/schemas/Carousel"
                  },
                  {
                    "$ref": "#/components/schemas/OrderDetails"
                  },
                  {
                    "$ref": "#/components/schemas/OrderStatus"
                  }
                ]
              }
            }
          }
        ]
      },
      "ReactionMessage": {
        "title": "Reaction",
        "description": "An emoji reaction to a message in the chat. You can react to messages up to 30 days old.",
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "reaction"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "reaction"
              },
              "reaction": {
                "type": "object",
                "required": [
                  "message_id",
                  "emoji"
                ],
                "properties": {
                  "message_id": {
                    "type": "string",
                    "description": "ID of the message to react to."
                  },
                  "emoji": {
                    "type": "string",
                    "description": "A single emoji. Send an empty string to remove your reaction."
                  }
                }
              }
            }
          }
        ]
      },
      "MarkAsRead": {
        "title": "Mark as read",
        "type": "object",
        "description": "Marks an incoming message, and every earlier message in the chat, as read. The customer sees blue ticks.",
        "required": [
          "messaging_product",
          "status",
          "message_id"
        ],
        "properties": {
          "messaging_product": {
            "type": "string",
            "const": "whatsapp"
          },
          "status": {
            "type": "string",
            "const": "read"
          },
          "message_id": {
            "type": "string",
            "description": "ID of the incoming message."
          }
        }
      },
      "SendMessageRequest": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextMessage"
          },
          {
            "$ref": "#/components/schemas/TemplateMessage"
          },
          {
            "$ref": "#/components/schemas/ImageMessage"
          },
          {
            "$ref": "#/components/schemas/VideoMessage"
          },
          {
            "$ref": "#/components/schemas/AudioMessage"
          },
          {
            "$ref": "#/components/schemas/DocumentMessage"
          },
          {
            "$ref": "#/components/schemas/StickerMessage"
          },
          {
            "$ref": "#/components/schemas/LocationMessage"
          },
          {
            "$ref": "#/components/schemas/ContactsMessage"
          },
          {
            "$ref": "#/components/schemas/InteractiveMessage"
          },
          {
            "$ref": "#/components/schemas/ReactionMessage"
          },
          {
            "$ref": "#/components/schemas/MarkAsRead"
          }
        ]
      },
      "SendResponse": {
        "title": "Message accepted",
        "type": "object",
        "required": [
          "messaging_product",
          "messages"
        ],
        "properties": {
          "messaging_product": {
            "type": "string",
            "const": "whatsapp"
          },
          "contacts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "input": {
                  "type": "string",
                  "description": "The `to` value you sent."
                },
                "wa_id": {
                  "type": "string",
                  "description": "The customer's WhatsApp ID."
                }
              }
            }
          },
          "messages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Message ID. Status webhooks for this message carry the same ID."
                },
                "message_status": {
                  "type": "string",
                  "enum": [
                    "accepted",
                    "held_for_quality_assessment"
                  ],
                  "description": "Templates only: `held_for_quality_assessment` means WhatsApp is pacing a marketing template while it checks how customers react to it."
                }
              }
            }
          }
        }
      },
      "ReadResponse": {
        "title": "Marked as read",
        "type": "object",
        "required": [
          "success"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "const": true
          }
        }
      },
      "WhatsAppError": {
        "title": "WhatsApp error",
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "What went wrong, for your logs. Not written for customers."
              },
              "type": {
                "type": "string"
              },
              "code": {
                "type": "integer",
                "description": "Error code. See [Errors](/docs/whatsapp/errors)."
              },
              "error_subcode": {
                "type": "integer"
              },
              "error_data": {
                "type": "object",
                "properties": {
                  "messaging_product": {
                    "type": "string"
                  },
                  "details": {
                    "type": "string",
                    "description": "More detail about the error."
                  }
                }
              },
              "fbtrace_id": {
                "type": "string",
                "description": "Trace ID. Include it when you contact support."
              }
            }
          }
        }
      },
      "GatewayError": {
        "title": "DoveMesh error",
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Error code."
          },
          "message": {
            "type": "string",
            "description": "What went wrong."
          }
        }
      },
      "UploadMediaRequest": {
        "type": "object",
        "required": [
          "sheet"
        ],
        "properties": {
          "sheet": {
            "type": "string",
            "format": "binary",
            "description": "The file. The form field is named `sheet`."
          }
        }
      },
      "MediaUploaded": {
        "title": "Media uploaded",
        "type": "object",
        "properties": {
          "response": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Media ID. Use it in messages for 30 days."
              }
            }
          }
        }
      },
      "MediaUrl": {
        "title": "Media URL",
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "description": "Where to download the file. Fetch it with your `apikey` header within 5 minutes."
          },
          "mime_type": {
            "type": "string",
            "description": "File type, such as `image/jpeg`."
          },
          "sha256": {
            "type": "string",
            "description": "SHA-256 checksum of the file, to check the download."
          },
          "file_size": {
            "type": "integer",
            "description": "Size in bytes."
          },
          "id": {
            "type": "string"
          },
          "messaging_product": {
            "type": "string",
            "const": "whatsapp"
          }
        }
      },
      "SuccessResult": {
        "title": "Success",
        "type": "object",
        "required": [
          "success"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "const": true
          }
        }
      },
      "TemplateStatus": {
        "type": "string",
        "enum": [
          "PENDING",
          "APPROVED",
          "REJECTED",
          "PAUSED",
          "DISABLED",
          "IN_APPEAL",
          "PENDING_DELETION"
        ],
        "description": "- `PENDING`: waiting for review.\n- `APPROVED`: ready to send.\n- `REJECTED`: not approved. See `rejected_reason`; edit it and it's reviewed again.\n- `PAUSED`: stopped for a few hours because customers reported or blocked it.\n- `DISABLED`: stopped for good after repeated quality problems.\n- `IN_APPEAL`: you've asked WhatsApp to look again.\n- `PENDING_DELETION`: being deleted.\n"
      },
      "ParameterFormat": {
        "type": "string",
        "enum": [
          "POSITIONAL",
          "NAMED"
        ],
        "default": "POSITIONAL",
        "description": "How the placeholders are written: `POSITIONAL` for `{{1}}`, `{{2}}`, or `NAMED` for names such as `{{first_name}}`. See [Placeholders](/docs/whatsapp/templates#placeholders)."
      },
      "NamedParamExample": {
        "type": "object",
        "required": [
          "param_name",
          "example"
        ],
        "properties": {
          "param_name": {
            "type": "string",
            "pattern": "^[a-z_]+$",
            "description": "The placeholder's name without braces, such as `first_name`. Lowercase letters and underscores."
          },
          "example": {
            "type": "string",
            "description": "An example value, such as `Priya`."
          }
        }
      },
      "HeaderComponent": {
        "title": "Header",
        "type": "object",
        "required": [
          "type",
          "format"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "HEADER"
          },
          "format": {
            "type": "string",
            "enum": [
              "TEXT",
              "IMAGE",
              "VIDEO",
              "DOCUMENT",
              "LOCATION"
            ],
            "description": "What the header shows. For `LOCATION`, you send the location with each message."
          },
          "text": {
            "type": "string",
            "maxLength": 60,
            "description": "`TEXT` headers only. Can contain one placeholder: `{{1}}`, or a name such as `{{order_id}}` in a named template."
          },
          "example": {
            "type": "object",
            "description": "Examples for the reviewers.",
            "properties": {
              "header_text": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Example value for the `{{1}}` placeholder in a text header."
              },
              "header_text_named_params": {
                "type": "array",
                "maxItems": 1,
                "description": "Named templates: the example for the text header's placeholder, by name.",
                "items": {
                  "$ref": "#/components/schemas/NamedParamExample"
                }
              },
              "header_handle": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "`IMAGE`, `VIDEO` and `DOCUMENT` headers: the handle of a sample file, from [Template samples](/docs/whatsapp/template-samples)."
              }
            }
          }
        }
      },
      "BodyComponent": {
        "title": "Body",
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "BODY"
          },
          "text": {
            "type": "string",
            "maxLength": 1024,
            "description": "The main text, with placeholders `{{1}}`, `{{2}}` and so on, or names such as `{{first_name}}` in a named template. Required, except in authentication templates, where WhatsApp writes the text."
          },
          "example": {
            "type": "object",
            "properties": {
              "body_text": {
                "type": "array",
                "description": "One list of example values, one value per placeholder, in order.",
                "items": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "body_text_named_params": {
                "type": "array",
                "description": "Named templates: one example per placeholder, by name.",
                "items": {
                  "$ref": "#/components/schemas/NamedParamExample"
                }
              }
            }
          },
          "add_security_recommendation": {
            "type": "boolean",
            "description": "Authentication templates only: add “For your security, do not share this code.”"
          }
        }
      },
      "FooterComponent": {
        "title": "Footer",
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "FOOTER"
          },
          "text": {
            "type": "string",
            "maxLength": 60,
            "description": "Small grey text. No placeholders."
          },
          "code_expiration_minutes": {
            "type": "integer",
            "minimum": 1,
            "maximum": 90,
            "description": "Authentication templates only: show “This code expires in N minutes.” instead of text."
          }
        }
      },
      "TemplateButton": {
        "oneOf": [
          {
            "title": "Quick reply",
            "type": "object",
            "required": [
              "type",
              "text"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "QUICK_REPLY"
              },
              "text": {
                "type": "string",
                "maxLength": 25,
                "description": "Button label. When tapped, you receive an incoming message of type `button`."
              }
            }
          },
          {
            "title": "Website",
            "type": "object",
            "required": [
              "type",
              "text",
              "url"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "URL"
              },
              "text": {
                "type": "string",
                "maxLength": 25
              },
              "url": {
                "type": "string",
                "description": "The link. It can end with one placeholder, such as `https://example.com/track/{{1}}`, filled in when you send."
              },
              "example": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Example of the full link, needed when `url` has a placeholder."
              }
            }
          },
          {
            "title": "Phone number",
            "type": "object",
            "required": [
              "type",
              "text",
              "phone_number"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "PHONE_NUMBER"
              },
              "text": {
                "type": "string",
                "maxLength": 25
              },
              "phone_number": {
                "type": "string",
                "description": "Number to call, with country code, such as `+919876500000`."
              }
            }
          },
          {
            "title": "Copy code",
            "type": "object",
            "required": [
              "type",
              "example"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "COPY_CODE"
              },
              "example": {
                "type": [
                  "string",
                  "array"
                ],
                "items": {
                  "type": "string"
                },
                "description": "An example coupon code, up to 15 characters. You send the real code with each message. Templates you read back return it as a list."
              }
            }
          },
          {
            "title": "Catalog",
            "type": "object",
            "required": [
              "type",
              "text"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "CATALOG"
              },
              "text": {
                "type": "string",
                "description": "Button label, such as “View catalog”."
              }
            }
          },
          {
            "title": "Multi-product",
            "type": "object",
            "required": [
              "type",
              "text"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "MPM"
              },
              "text": {
                "type": "string",
                "description": "Button label, such as “View items”."
              }
            }
          },
          {
            "title": "One-time password",
            "type": "object",
            "description": "Authentication templates only.",
            "required": [
              "type",
              "otp_type"
            ],
            "properties": {
              "type": {
                "type": "string",
                "const": "OTP"
              },
              "otp_type": {
                "type": "string",
                "enum": [
                  "copy_code",
                  "one_tap",
                  "zero_tap"
                ],
                "description": "`copy_code`: the customer copies the code. `one_tap`: a button fills the code into your Android app. `zero_tap`: your Android app receives the code without a tap."
              },
              "text": {
                "type": "string",
                "description": "Label of the copy button."
              },
              "autofill_text": {
                "type": "string",
                "description": "`one_tap` and `zero_tap`: label of the autofill button."
              },
              "zero_tap_terms_accepted": {
                "type": "boolean",
                "description": "`zero_tap`: you accept WhatsApp's zero-tap terms."
              },
              "supported_apps": {
                "type": "array",
                "description": "`one_tap` and `zero_tap`: the Android apps that may receive the code.",
                "items": {
                  "type": "object",
                  "required": [
                    "package_name",
                    "signature_hash"
                  ],
                  "properties": {
                    "package_name": {
                      "type": "string",
                      "description": "Your app's package name, such as `com.example.app`."
                    },
                    "signature_hash": {
                      "type": "string",
                      "description": "Your app's signing key hash."
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "ButtonsComponent": {
        "title": "Buttons",
        "type": "object",
        "required": [
          "type",
          "buttons"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "BUTTONS"
          },
          "buttons": {
            "type": "array",
            "minItems": 1,
            "maxItems": 10,
            "description": "Up to 10 buttons. At most 2 website buttons, 1 phone number button and 1 copy-code button.",
            "items": {
              "$ref": "#/components/schemas/TemplateButton"
            }
          }
        }
      },
      "CarouselComponent": {
        "title": "Carousel",
        "type": "object",
        "description": "2 to 10 cards. Every card must have the same structure (header type, number and kind of buttons).",
        "required": [
          "type",
          "cards"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "CAROUSEL"
          },
          "cards": {
            "type": "array",
            "minItems": 2,
            "maxItems": 10,
            "items": {
              "type": "object",
              "required": [
                "components"
              ],
              "properties": {
                "components": {
                  "type": "array",
                  "description": "The card's `HEADER` (`IMAGE` or `VIDEO`), `BODY` and `BUTTONS` (up to 2).",
                  "items": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/HeaderComponent"
                      },
                      {
                        "$ref": "#/components/schemas/BodyComponent"
                      },
                      {
                        "$ref": "#/components/schemas/ButtonsComponent"
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "LimitedTimeOfferComponent": {
        "title": "Limited-time offer",
        "type": "object",
        "description": "An offer banner; you send the end time with each message. WhatsApp rejects a limited-time offer template that breaks these rules:\n\n- `MARKETING` category only.\n- Header optional, and only `IMAGE` or `VIDEO`.\n- No footer.\n- Body up to 600 characters.\n- A website (`URL`) button is required; a copy-code button is optional.\n\nCustomers on WhatsApp Web and desktop don't see the offer.\n",
        "required": [
          "type",
          "limited_time_offer"
        ],
        "properties": {
          "type": {
            "type": "string",
            "const": "LIMITED_TIME_OFFER"
          },
          "limited_time_offer": {
            "type": "object",
            "required": [
              "text"
            ],
            "properties": {
              "text": {
                "type": "string",
                "maxLength": 16,
                "description": "Banner text, such as “Expiring offer!”."
              },
              "has_expiration": {
                "type": "boolean",
                "description": "Show a countdown to the end time."
              }
            }
          }
        }
      },
      "TemplateComponent": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/HeaderComponent"
          },
          {
            "$ref": "#/components/schemas/BodyComponent"
          },
          {
            "$ref": "#/components/schemas/FooterComponent"
          },
          {
            "$ref": "#/components/schemas/ButtonsComponent"
          },
          {
            "$ref": "#/components/schemas/CarouselComponent"
          },
          {
            "$ref": "#/components/schemas/LimitedTimeOfferComponent"
          }
        ]
      },
      "Template": {
        "title": "Template",
        "type": "object",
        "description": "A template as WhatsApp returns it. DoveMesh passes WhatsApp's fields through unchanged, so a template can carry fields not listed here; ignore the ones you don't use.",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "parameter_format": {
            "$ref": "#/components/schemas/ParameterFormat"
          },
          "language": {
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/TemplateStatus"
          },
          "category": {
            "type": "string",
            "enum": [
              "MARKETING",
              "UTILITY",
              "AUTHENTICATION"
            ]
          },
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TemplateComponent"
            }
          },
          "rejected_reason": {
            "type": "string",
            "description": "Why WhatsApp rejected the template, when `status` is `REJECTED`."
          },
          "disable_ios_autofill": {
            "type": "boolean",
            "description": "Whether code autofill on iPhones is turned off. Only matters for authentication templates."
          },
          "is_primary_device_delivery_only": {
            "type": "boolean",
            "description": "Whether the message is delivered only to the customer's main phone, not their linked devices such as WhatsApp Web. Only matters for authentication templates."
          }
        }
      },
      "Paging": {
        "type": "object",
        "description": "Cursors for the next and previous pages. Pass `after` to get the next page and `before` to go back.",
        "properties": {
          "cursors": {
            "type": "object",
            "properties": {
              "before": {
                "type": "string"
              },
              "after": {
                "type": "string"
              }
            }
          },
          "next": {
            "type": "string",
            "description": "Full URL of the next page, if there is one."
          },
          "previous": {
            "type": "string",
            "description": "Full URL of the previous page, if there is one."
          }
        }
      },
      "TemplateList": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Template"
            }
          },
          "paging": {
            "$ref": "#/components/schemas/Paging"
          }
        }
      },
      "CreateTemplateRequest": {
        "type": "object",
        "required": [
          "name",
          "language",
          "category",
          "components"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 512,
            "pattern": "^[a-z0-9_]+$",
            "description": "Lowercase letters, numbers and underscores only, such as `order_shipped`."
          },
          "language": {
            "type": "string",
            "description": "Language code, such as `en`, `en_US`, `hi` or `ta`. Create the same name again with another code to add a language."
          },
          "category": {
            "type": "string",
            "enum": [
              "MARKETING",
              "UTILITY",
              "AUTHENTICATION"
            ],
            "description": "What the template is for. See [Categories](/docs/whatsapp/templates)."
          },
          "allow_category_change": {
            "type": "boolean",
            "default": false,
            "description": "Let WhatsApp change the category if it disagrees, instead of rejecting the template."
          },
          "parameter_format": {
            "$ref": "#/components/schemas/ParameterFormat"
          },
          "message_send_ttl_seconds": {
            "type": "integer",
            "description": "Authentication templates only: how long WhatsApp keeps trying to deliver the message before giving up, in seconds. Set it to match your code's expiry."
          },
          "components": {
            "type": "array",
            "minItems": 1,
            "description": "The template's parts. A body is required.",
            "items": {
              "$ref": "#/components/schemas/TemplateComponent"
            }
          }
        }
      },
      "TemplateCreated": {
        "title": "Template created",
        "type": "object",
        "required": [
          "id",
          "status",
          "category"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The new template's ID."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TemplateStatus"
              }
            ],
            "description": "Usually `PENDING`. WhatsApp can also decide at once, so it can already be `APPROVED` or `REJECTED`."
          },
          "category": {
            "type": "string",
            "description": "The category WhatsApp assigned."
          }
        }
      },
      "UpdateTemplateRequest": {
        "type": "object",
        "description": "Send the new `components`, a new `category`, or both. Only a template that is `APPROVED`, `REJECTED` or `PAUSED` can be edited.",
        "properties": {
          "category": {
            "type": "string",
            "enum": [
              "MARKETING",
              "UTILITY",
              "AUTHENTICATION"
            ]
          },
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TemplateComponent"
            }
          },
          "name": {
            "type": "string",
            "description": "Must match the template's current name. Names can't be changed."
          },
          "language": {
            "type": "string",
            "description": "Must match the template's current language."
          },
          "allow_category_change": {
            "type": "boolean"
          },
          "message_send_ttl_seconds": {
            "type": "integer"
          }
        }
      },
      "UploadSession": {
        "title": "Upload session",
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Session ID, starting with `upload:`. It includes a `?sig=` part; keep it exactly as returned."
          }
        }
      },
      "UploadHandle": {
        "title": "File handle",
        "type": "object",
        "required": [
          "h"
        ],
        "properties": {
          "h": {
            "type": "string",
            "description": "The file handle. Put it in `example.header_handle` when you create the template."
          }
        }
      },
      "CatalogIdResult": {
        "title": "Catalog ID",
        "type": "object",
        "properties": {
          "code": {
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "data": {
            "type": "object",
            "properties": {
              "catlogid": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Your catalog ID, or `null` when no catalog is connected to the number. The field name is spelled `catlogid`."
              }
            }
          }
        }
      },
      "Product": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Meta's ID for the product."
          },
          "retailer_id": {
            "type": "string",
            "description": "Your ID (SKU) for the product."
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "price": {
            "type": "string",
            "description": "Price as display text, such as `₹499.00`."
          },
          "availability": {
            "type": "string"
          },
          "brand": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "image_url": {
            "type": "string",
            "format": "uri"
          },
          "retailer_product_group_id": {
            "type": "string",
            "description": "Groups variants of one product, such as sizes."
          }
        }
      },
      "CatalogProducts": {
        "title": "Products",
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Product"
            }
          },
          "paging": {
            "$ref": "#/components/schemas/Paging"
          }
        }
      },
      "ProductData": {
        "type": "object",
        "description": "Product details. Required for `CREATE`; for `UPDATE`, send only what changes; leave it out for `DELETE`.",
        "properties": {
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "price": {
            "type": "integer",
            "description": "Price in the smallest unit of the currency (paise for INR), so ₹499.00 is `49900`."
          },
          "currency": {
            "type": "string",
            "description": "Currency code, such as `INR`."
          },
          "availability": {
            "type": "string",
            "description": "Such as `in stock` or `out of stock`."
          },
          "condition": {
            "type": "string",
            "enum": [
              "new",
              "refurbished",
              "used"
            ]
          },
          "brand": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "image_url": {
            "type": "string",
            "format": "uri",
            "description": "Public HTTPS link to the product image."
          },
          "url": {
            "type": "string",
            "format": "uri",
            "description": "The product's page on your website."
          },
          "retailer_product_group_id": {
            "type": "string",
            "description": "Groups variants of one product, such as sizes or colours."
          }
        }
      },
      "ProductBatchRequest": {
        "type": "object",
        "required": [
          "requests"
        ],
        "properties": {
          "requests": {
            "type": "array",
            "minItems": 1,
            "description": "One entry per product to create, update or delete.",
            "items": {
              "type": "object",
              "required": [
                "method",
                "retailer_id"
              ],
              "properties": {
                "method": {
                  "type": "string",
                  "enum": [
                    "CREATE",
                    "UPDATE",
                    "DELETE"
                  ]
                },
                "retailer_id": {
                  "type": "string",
                  "description": "Your ID (SKU) for the product. It identifies the product in updates, deletes and messages."
                },
                "data": {
                  "$ref": "#/components/schemas/ProductData"
                }
              }
            }
          }
        }
      },
      "ProductBatchResult": {
        "title": "Batch accepted",
        "type": "object",
        "properties": {
          "handles": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "IDs of the batch. The changes are applied within a few minutes."
          }
        }
      },
      "PaymentStatus": {
        "title": "Payment",
        "type": "object",
        "properties": {
          "payments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "reference_id": {
                  "type": "string",
                  "description": "Your order ID."
                },
                "status": {
                  "type": "string",
                  "description": "The payment's state, such as `PENDING` (not paid yet) or `CAPTURED` (paid). Always confirm with your payment gateway before you ship."
                },
                "amount": {
                  "$ref": "#/components/schemas/Amount"
                },
                "currency": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "RefundRequest": {
        "type": "object",
        "required": [
          "reference_id",
          "payment_config_id",
          "amount"
        ],
        "properties": {
          "reference_id": {
            "type": "string",
            "description": "Your order ID from the payment request."
          },
          "payment_config_id": {
            "type": "string",
            "description": "Name of your payment configuration."
          },
          "speed": {
            "type": "string",
            "enum": [
              "normal"
            ],
            "default": "normal"
          },
          "amount": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Amount"
              },
              {
                "type": "object",
                "properties": {
                  "currency": {
                    "type": "string",
                    "const": "INR"
                  }
                }
              }
            ],
            "description": "How much to refund. Up to the amount paid."
          }
        }
      },
      "RefundResult": {
        "title": "Refund started",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Refund ID."
          },
          "status": {
            "type": "string",
            "description": "Starts as `pending`. Your payment gateway completes it."
          },
          "speed_processed": {
            "type": "string"
          }
        }
      },
      "QrCode": {
        "title": "QR code",
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "The QR code's ID."
          },
          "prefilled_message": {
            "type": "string",
            "description": "Message typed in for the person when they open the chat."
          },
          "deep_link_url": {
            "type": "string",
            "format": "uri",
            "description": "Short link that opens the chat."
          },
          "qr_image_url": {
            "type": "string",
            "format": "uri",
            "description": "Link to the QR image, when you ask for one. The link is temporary; download the image if you need to keep it."
          }
        }
      },
      "QrCodeList": {
        "title": "QR codes",
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/QrCode"
            }
          }
        }
      },
      "QrCodeRequest": {
        "type": "object",
        "required": [
          "prefilled_message"
        ],
        "properties": {
          "prefilled_message": {
            "type": "string",
            "description": "Message typed in for the person when they open the chat."
          },
          "generate_qr_image": {
            "type": "string",
            "enum": [
              "PNG",
              "SVG"
            ],
            "description": "Also create a QR image in this format."
          },
          "code": {
            "type": "string",
            "description": "To **update** an existing code, its ID. Leave it out to create a new code."
          }
        }
      },
      "FlowsPrivateKey": {
        "title": "Private key",
        "type": "object",
        "properties": {
          "result": {
            "type": "string",
            "description": "The RSA private key in PEM format. Store it securely on your server."
          }
        }
      },
      "PhoneNumberList": {
        "title": "Your phone numbers",
        "type": "object",
        "properties": {
          "code": {
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "whatsapp_business_account_id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID (`waba_id`)."
                },
                "wanumber": {
                  "type": "string",
                  "description": "The phone number, with `+` and country code."
                },
                "phone_number_id": {
                  "type": "string",
                  "description": "The number's ID, used to send messages."
                }
              }
            }
          }
        }
      },
      "Balance": {
        "title": "Balance",
        "type": "object",
        "required": [
          "phone_number_id",
          "currency",
          "balance",
          "updated_at",
          "stale"
        ],
        "properties": {
          "phone_number_id": {
            "type": "string",
            "description": "The number this balance is for."
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD"
            ],
            "description": "Your wallet's currency, set when DoveMesh set up the number's credit."
          },
          "balance": {
            "$ref": "#/components/schemas/Amount",
            "description": "Message credit left. ₹1,530.00 is `{ \"value\": 153000, \"offset\": 100 }`."
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the balance was last read. Refreshed at most once a minute."
          },
          "stale": {
            "type": "boolean",
            "description": "`true` when the balance couldn't be refreshed just now: this is the last one read, from `updated_at`."
          }
        }
      },
      "BusinessAccount": {
        "title": "WhatsApp Business Account",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The `waba_id`."
          },
          "name": {
            "type": "string",
            "description": "Account name."
          },
          "currency": {
            "type": "string",
            "description": "Currency WhatsApp bills this account in."
          },
          "timezone_id": {
            "type": "string",
            "description": "Meta time zone ID."
          },
          "message_template_namespace": {
            "type": "string",
            "description": "Namespace of your templates. Only needed by older integrations."
          }
        }
      },
      "Metadata": {
        "type": "object",
        "description": "Which of your numbers the event is about.",
        "properties": {
          "display_phone_number": {
            "type": "string",
            "description": "Your WhatsApp number."
          },
          "phone_number_id": {
            "type": "string",
            "description": "Its `phone_number_id`."
          }
        }
      },
      "IncomingMedia": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Media ID. [Download it](/docs/whatsapp/media/download-media) promptly."
          },
          "mime_type": {
            "type": "string"
          },
          "sha256": {
            "type": "string"
          },
          "caption": {
            "type": "string"
          }
        }
      },
      "WebhookError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "Error code."
          },
          "title": {
            "type": "string",
            "description": "Short description."
          },
          "details": {
            "type": "string"
          },
          "href": {
            "type": "string",
            "description": "Link to Meta's description of the error."
          }
        }
      },
      "IncomingMessage": {
        "type": "object",
        "required": [
          "from",
          "id",
          "timestamp",
          "type"
        ],
        "properties": {
          "from": {
            "type": "string",
            "description": "The customer's WhatsApp ID."
          },
          "id": {
            "type": "string",
            "description": "Message ID. Use it to reply, react or mark as read."
          },
          "timestamp": {
            "type": "string",
            "description": "When the customer sent it, as a Unix timestamp in seconds."
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "image",
              "video",
              "audio",
              "document",
              "sticker",
              "location",
              "contacts",
              "interactive",
              "button",
              "reaction",
              "order",
              "system",
              "unknown"
            ],
            "description": "What was sent. The content is in the field with the same name:\n- `text`, `image`, `video`, `audio` (including voice notes), `document`, `sticker`, `location`, `contacts`: ordinary messages.\n- `interactive`: a tap on your reply button (`button_reply`) or list (`list_reply`), or a filled-in address form.\n- `button`: a tap on a quick-reply button in a template.\n- `reaction`: an emoji reaction to one of your messages.\n- `order`: a cart sent from your catalog.\n- `system`: the customer changed their phone number.\n- `unknown`: a message type WhatsApp doesn't support, such as a disappearing message.\n"
          },
          "context": {
            "type": "object",
            "description": "Present when the message replies to, or was sent from, one of your messages.",
            "properties": {
              "from": {
                "type": "string"
              },
              "id": {
                "type": "string",
                "description": "ID of your message."
              },
              "referred_product": {
                "type": "object",
                "description": "The product the customer asked about.",
                "properties": {
                  "catalog_id": {
                    "type": "string"
                  },
                  "product_retailer_id": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "referral": {
            "type": "object",
            "description": "Present when the customer came from a click-to-WhatsApp ad or post.",
            "properties": {
              "source_url": {
                "type": "string"
              },
              "source_id": {
                "type": "string"
              },
              "source_type": {
                "type": "string",
                "enum": [
                  "ad",
                  "post"
                ]
              },
              "headline": {
                "type": "string"
              },
              "body": {
                "type": "string"
              },
              "media_type": {
                "type": "string"
              },
              "image_url": {
                "type": "string"
              },
              "video_url": {
                "type": "string"
              },
              "thumbnail_url": {
                "type": "string"
              }
            }
          },
          "text": {
            "type": "object",
            "properties": {
              "body": {
                "type": "string"
              }
            }
          },
          "image": {
            "$ref": "#/components/schemas/IncomingMedia"
          },
          "video": {
            "$ref": "#/components/schemas/IncomingMedia"
          },
          "audio": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IncomingMedia"
              },
              {
                "type": "object",
                "properties": {
                  "voice": {
                    "type": "boolean",
                    "description": "`true` for a voice note."
                  }
                }
              }
            ]
          },
          "document": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IncomingMedia"
              },
              {
                "type": "object",
                "properties": {
                  "filename": {
                    "type": "string"
                  }
                }
              }
            ]
          },
          "sticker": {
            "$ref": "#/components/schemas/IncomingMedia"
          },
          "location": {
            "type": "object",
            "properties": {
              "latitude": {
                "type": "number"
              },
              "longitude": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "address": {
                "type": "string"
              }
            }
          },
          "contacts": {
            "type": "array",
            "description": "Contact cards, in the same format you use to [send them](/docs/whatsapp/messages/send-message).",
            "items": {
              "type": "object"
            }
          },
          "interactive": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "button_reply",
                  "list_reply",
                  "nfm_reply"
                ]
              },
              "button_reply": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "The `id` you gave the button."
                  },
                  "title": {
                    "type": "string"
                  }
                }
              },
              "list_reply": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "The `id` you gave the row."
                  },
                  "title": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "button": {
            "type": "object",
            "properties": {
              "text": {
                "type": "string",
                "description": "The button's label."
              },
              "payload": {
                "type": "string",
                "description": "The `payload` you sent with the template."
              }
            }
          },
          "reaction": {
            "type": "object",
            "properties": {
              "message_id": {
                "type": "string",
                "description": "Your message the customer reacted to."
              },
              "emoji": {
                "type": "string",
                "description": "The emoji. Empty when the customer removed their reaction."
              }
            }
          },
          "order": {
            "type": "object",
            "properties": {
              "catalog_id": {
                "type": "string"
              },
              "text": {
                "type": "string",
                "description": "Note the customer added to the order."
              },
              "product_items": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "product_retailer_id": {
                      "type": "string"
                    },
                    "quantity": {
                      "type": [
                        "string",
                        "integer"
                      ]
                    },
                    "item_price": {
                      "type": [
                        "string",
                        "number"
                      ]
                    },
                    "currency": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "system": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "const": "user_changed_number"
              },
              "body": {
                "type": "string"
              },
              "new_wa_id": {
                "type": "string",
                "description": "The customer's new WhatsApp ID. Update your records."
              }
            }
          },
          "errors": {
            "type": "array",
            "description": "`unknown` messages only: why the message couldn't be read.",
            "items": {
              "$ref": "#/components/schemas/WebhookError"
            }
          }
        }
      },
      "IncomingMessageEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "messages"
                      },
                      "value": {
                        "type": "object",
                        "properties": {
                          "messaging_product": {
                            "type": "string",
                            "const": "whatsapp"
                          },
                          "metadata": {
                            "$ref": "#/components/schemas/Metadata"
                          },
                          "contacts": {
                            "type": "array",
                            "description": "Who sent the message.",
                            "items": {
                              "type": "object",
                              "properties": {
                                "profile": {
                                  "type": "object",
                                  "properties": {
                                    "name": {
                                      "type": "string",
                                      "description": "The customer's WhatsApp profile name."
                                    }
                                  }
                                },
                                "wa_id": {
                                  "type": "string",
                                  "description": "The customer's WhatsApp ID. Send replies to it."
                                }
                              }
                            }
                          },
                          "messages": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/IncomingMessage"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "MessageStatus": {
        "type": "object",
        "required": [
          "id",
          "status",
          "timestamp",
          "recipient_id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The message ID you got when you sent the message."
          },
          "status": {
            "type": "string",
            "enum": [
              "sent",
              "delivered",
              "read",
              "failed",
              "deleted"
            ],
            "description": "- `sent`: WhatsApp sent the message.\n- `delivered`: it reached the customer's phone.\n- `read`: the customer opened it. Not sent if they've turned read receipts off.\n- `failed`: it couldn't be delivered. See `errors`.\n- `deleted`: the message was deleted.\n"
          },
          "timestamp": {
            "type": "string",
            "description": "When the status changed, as a Unix timestamp in seconds."
          },
          "recipient_id": {
            "type": "string",
            "description": "The customer's WhatsApp ID."
          },
          "pricing": {
            "type": "object",
            "description": "How WhatsApp charges for this message.",
            "properties": {
              "billable": {
                "type": "boolean",
                "description": "Whether the message is charged."
              },
              "pricing_model": {
                "type": "string",
                "const": "PMP",
                "description": "Per-message pricing."
              },
              "category": {
                "type": "string",
                "description": "`marketing`, `marketing_lite`, `utility`, `authentication`, `authentication_international`, `service` or `referral_conversion`. Same as the template's category, or `service` for replies inside the 24-hour window."
              },
              "type": {
                "type": "string",
                "description": "`regular` (charged), `free_customer_service` (free, inside the 24-hour window) or `free_entry_point` (free, after a click-to-WhatsApp ad)."
              }
            }
          },
          "conversation": {
            "type": "object",
            "description": "The conversation the message belongs to, when WhatsApp includes it.",
            "properties": {
              "id": {
                "type": "string"
              },
              "expiration_timestamp": {
                "type": "string"
              },
              "origin": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "errors": {
            "type": "array",
            "description": "`failed` only: why the message failed. See [Errors](/docs/whatsapp/errors).",
            "items": {
              "$ref": "#/components/schemas/WebhookError"
            }
          }
        }
      },
      "MessageStatusEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "messages"
                      },
                      "value": {
                        "type": "object",
                        "properties": {
                          "messaging_product": {
                            "type": "string",
                            "const": "whatsapp"
                          },
                          "metadata": {
                            "$ref": "#/components/schemas/Metadata"
                          },
                          "statuses": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/MessageStatus"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "TemplateStatusValue": {
        "type": "object",
        "properties": {
          "event": {
            "type": "string",
            "enum": [
              "APPROVED",
              "REJECTED",
              "FLAGGED",
              "PAUSED",
              "DISABLED",
              "PENDING_DELETION",
              "REINSTATED"
            ],
            "description": "- `APPROVED`: ready to send.\n- `REJECTED`: not approved; see `reason`.\n- `FLAGGED`: quality is low; it will be disabled on `disable_info.disable_date` unless quality improves.\n- `PAUSED`: stopped for a few hours; see `other_info`.\n- `DISABLED`: stopped for good.\n- `PENDING_DELETION`: being deleted.\n- `REINSTATED`: usable again.\n"
          },
          "message_template_id": {
            "type": "integer"
          },
          "message_template_name": {
            "type": "string"
          },
          "message_template_language": {
            "type": "string"
          },
          "reason": {
            "type": [
              "string",
              "null"
            ],
            "description": "Why it was rejected, such as `INCORRECT_CATEGORY`, `INVALID_FORMAT` or `PROMOTIONAL`. `NONE` or empty otherwise."
          },
          "disable_info": {
            "type": "object",
            "properties": {
              "disable_date": {
                "type": "string"
              }
            }
          },
          "other_info": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "description": "Such as `FIRST_PAUSE` or `SECOND_PAUSE`."
              },
              "description": {
                "type": "string"
              }
            }
          }
        }
      },
      "TemplateStatusEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "message_template_status_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/TemplateStatusValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "TemplateCategoryValue": {
        "type": "object",
        "properties": {
          "message_template_id": {
            "type": "integer"
          },
          "message_template_name": {
            "type": "string"
          },
          "message_template_language": {
            "type": "string"
          },
          "previous_category": {
            "type": "string"
          },
          "new_category": {
            "type": "string"
          }
        }
      },
      "TemplateCategoryEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "template_category_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/TemplateCategoryValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "TemplateQualityValue": {
        "type": "object",
        "properties": {
          "message_template_id": {
            "type": "integer"
          },
          "message_template_name": {
            "type": "string"
          },
          "message_template_language": {
            "type": "string"
          },
          "previous_quality_score": {
            "type": "string",
            "description": "`GREEN` (high), `YELLOW` (medium), `RED` (low) or `UNKNOWN`."
          },
          "new_quality_score": {
            "type": "string"
          }
        }
      },
      "TemplateQualityEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "message_template_quality_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/TemplateQualityValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "PhoneNumberNameValue": {
        "type": "object",
        "properties": {
          "display_phone_number": {
            "type": "string"
          },
          "decision": {
            "type": "string",
            "enum": [
              "APPROVED",
              "REJECTED",
              "DEFERRED"
            ]
          },
          "requested_verified_name": {
            "type": "string",
            "description": "The display name you asked for."
          },
          "rejection_reason": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "PhoneNumberNameEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "phone_number_name_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/PhoneNumberNameValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "PhoneNumberQualityValue": {
        "type": "object",
        "properties": {
          "display_phone_number": {
            "type": "string"
          },
          "event": {
            "type": "string",
            "description": "`UPGRADE` or `DOWNGRADE` when your messaging limit changes, `FLAGGED` or `UNFLAGGED` when quality drops or recovers."
          },
          "current_limit": {
            "type": "string",
            "description": "Your messaging limit: `TIER_250`, `TIER_1K`, `TIER_10K`, `TIER_100K` or `TIER_UNLIMITED` new customers per 24 hours."
          }
        }
      },
      "PhoneNumberQualityEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "phone_number_quality_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/PhoneNumberQualityValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "AccountUpdateValue": {
        "type": "object",
        "properties": {
          "event": {
            "type": "string",
            "description": "- `VERIFIED_ACCOUNT`: your number was verified.\n- `ACCOUNT_VIOLATION`: WhatsApp found a policy violation; see `violation_info`.\n- `ACCOUNT_RESTRICTION`: some sending is blocked until `expiration`; see `restriction_info`.\n- `DISABLED_UPDATE`: the account is scheduled for disabling, disabled or reinstated; see `ban_info`.\n- `ACCOUNT_DELETED`: the account was deleted.\n- `BUSINESS_PRIMARY_LOCATION_COUNTRY_UPDATE`: your business's country was set.\n"
          },
          "phone_number": {
            "type": "string"
          },
          "violation_info": {
            "type": "object",
            "properties": {
              "violation_type": {
                "type": "string"
              }
            }
          },
          "restriction_info": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "restriction_type": {
                  "type": "string",
                  "description": "`RESTRICTED_BIZ_INITIATED_MESSAGING` (you can't start conversations), `RESTRICTED_CUSTOMER_INITIATED_MESSAGING` (you can't reply) or `RESTRICTION_ADD_PHONE_NUMBER_ACTION` (you can't add numbers)."
                },
                "expiration": {
                  "type": "integer",
                  "description": "When the restriction ends, as a Unix timestamp."
                }
              }
            }
          },
          "ban_info": {
            "type": "object",
            "properties": {
              "waba_ban_state": {
                "type": "string",
                "enum": [
                  "SCHEDULE_FOR_DISABLE",
                  "DISABLE",
                  "REINSTATE"
                ]
              },
              "waba_ban_date": {
                "type": "string"
              }
            }
          },
          "country": {
            "type": "string"
          }
        }
      },
      "AccountUpdateEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "account_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/AccountUpdateValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "AccountAlertValue": {
        "type": "object",
        "properties": {
          "entity_type": {
            "type": "string"
          },
          "entity_id": {
            "type": "string"
          },
          "alert_severity": {
            "type": "string",
            "enum": [
              "CRITICAL",
              "WARNING",
              "INFORMATIONAL"
            ]
          },
          "alert_status": {
            "type": "string"
          },
          "alert_type": {
            "type": "string",
            "description": "Such as `INCREASED_CAPABILITIES_ELIGIBILITY_FAILED`, `INCREASED_CAPABILITIES_ELIGIBILITY_DEFERRED` or `INCREASED_CAPABILITIES_ELIGIBILITY_NEED_MORE_INFO`."
          },
          "alert_description": {
            "type": "string",
            "description": "What happened and what to do, in plain words."
          }
        }
      },
      "AccountAlertEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "account_alerts"
                      },
                      "value": {
                        "$ref": "#/components/schemas/AccountAlertValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "AccountReviewValue": {
        "type": "object",
        "properties": {
          "decision": {
            "type": "string",
            "enum": [
              "APPROVED",
              "REJECTED",
              "PENDING",
              "DEFERRED"
            ]
          }
        }
      },
      "AccountReviewEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "account_review_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/AccountReviewValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "BusinessCapabilityValue": {
        "type": "object",
        "properties": {
          "max_daily_conversation_per_phone": {
            "type": "integer",
            "description": "New messaging limit for each of your numbers."
          },
          "max_phone_numbers_per_business": {
            "type": "integer",
            "description": "How many numbers your business can have."
          }
        }
      },
      "BusinessCapabilityEvent": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "whatsapp_business_account"
          },
          "entry": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Your WhatsApp Business Account ID."
                },
                "time": {
                  "type": "integer",
                  "description": "When the event happened, as a Unix timestamp in seconds."
                },
                "changes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "const": "business_capability_update"
                      },
                      "value": {
                        "$ref": "#/components/schemas/BusinessCapabilityValue"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "WhatsApp rejected the request. `error.code` says why; see [Errors](/docs/whatsapp/errors).",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/WhatsAppError"
            },
            "example": {
              "error": {
                "message": "(#100) Invalid parameter",
                "type": "OAuthException",
                "code": 100,
                "error_data": {
                  "messaging_product": "whatsapp",
                  "details": "Param name is required"
                },
                "fbtrace_id": "AbCdEfGh123"
              }
            }
          }
        }
      },
      "Unauthorized": {
        "description": "The `apikey` header is missing, wrong or revoked.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GatewayError"
            },
            "example": {
              "error": "invalid_api_key",
              "message": "The apikey header is missing, wrong or revoked. Create a key on the dashboard."
            }
          }
        }
      },
      "AccountSuspended": {
        "description": "The number's WhatsApp API plan isn't active (renew it on the dashboard), or the number is suspended (contact DoveMesh support).",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GatewayError"
            },
            "example": {
              "error": "account_suspended",
              "message": "This number's WhatsApp API plan isn't active. Renew it on the dashboard."
            }
          }
        }
      },
      "UpstreamUnreachable": {
        "description": "WhatsApp couldn't be reached. Retry with backoff.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GatewayError"
            },
            "example": {
              "error": "upstream_unreachable"
            }
          }
        }
      },
      "Success": {
        "description": "Done.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SuccessResult"
            },
            "example": {
              "success": true
            }
          }
        }
      },
      "WebhookReceived": {
        "description": "Respond with any `2xx` status within 10 seconds to confirm you received the event. Anything else is retried."
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "Messaging",
      "tags": [
        "Messages",
        "Media"
      ]
    },
    {
      "name": "Templates",
      "tags": [
        "Templates",
        "Template samples"
      ]
    },
    {
      "name": "Commerce",
      "tags": [
        "Catalog",
        "Payments"
      ]
    },
    {
      "name": "Growth tools",
      "tags": [
        "QR codes",
        "Flows"
      ]
    },
    {
      "name": "Settings",
      "tags": [
        "Account"
      ]
    }
  ]
}
