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

# Campaigns

> Send approved WhatsApp templates to your contacts at scale, schedule them, and track delivery.

## What is this?

**Campaigns** is where you send an approved WhatsApp template to a group of your contacts — immediately or on a schedule — and then follow how many messages were delivered, read, or failed.

![The Campaigns page showing the Total Campaigns, Active, and Completed tiles above the campaigns table](https://mintcdn.com/wabis/WS9kn1_MGeoTtoMA/images/campaigns-list.png?fit=max\&auto=format\&n=WS9kn1_MGeoTtoMA\&q=85\&s=94f0817c7fc9b924cf213029c1de1f5e)

> [!NOTE]
>
> Campaigns require the `campaigns:view` permission, an active WhatsApp channel, and a plan that includes WhatsApp integration. A campaign always sends an **approved template** — create one first in [Templates](https://wabis.mintlify.site/workspace/whatsapp/templates.md).

## What can I do here?

* See summary tiles: **Total Campaigns**, **Active**, and **Completed**
* Search campaigns by name
* Read each campaign's template, **Status**, **Labels**, **Recipients**, **Delivered**, **Read**, and **Failed** counts
* Create a new campaign with **Create Campaign** — the dialog shows an **Estimated cost** before you send
* Open the **Calculate charges** calculator to estimate WhatsApp message charges by country, category, and volume
* From a campaign's row menu: **View Details**, **Pause**, **Resume**, **Resend** (failed messages), **Cancel**, or **Export**
* Select multiple scheduled campaigns and **Cancel** them together
* Send a **carousel** template, with media and values for each card
* Open a campaign's analytics for delivery rates, daily performance, and error details

## How to use it

### Create a campaign

1. Go to **WhatsApp → Campaigns** and click **Create Campaign**.

2. Under **Campaign Details**, enter a **Campaign Name** and an optional **Description** for your team.

3. Under **Template Selection**, choose an approved **Template**. Use the search box to find it, and check the message preview.

   ![The Create New Campaign dialog with a template selected and its message preview](https://mintcdn.com/wabis/WS9kn1_MGeoTtoMA/images/campaigns-create-template.png?fit=max\&auto=format\&n=WS9kn1_MGeoTtoMA\&q=85\&s=7434d2035b523617925dfd15294d268b)

4. If the template has variables, fill in **Template Variables**. For each one, use **Free Text**, or **Custom Field** so the value is pulled from each contact's data (the default value is used if a contact's field is empty). If the template has a document header, upload it here. Enter **Button URL Values** for any dynamic URL buttons.

5. Under **Select Target Audience**, choose **All** contacts, **Unlabeled** contacts, or one or more labels. Contacts who have unsubscribed are excluded by default — turn on **Include Unsubscribed** only if you have the right to message them.

6. For a **marketing** template, **Send through Marketing Messages Lite** is on by default: the campaign is sent through Meta's Marketing Messages Lite API. Turn it off to send through the standard Cloud API instead. For other template categories the option is greyed out — they always use the standard Cloud API. Channels that have it available show an **MM Lite** badge on their card in [Channels](https://wabis.mintlify.site/workspace/channels/overview.md).

7. Optionally set **Schedule (Optional)**. Leave it empty to start immediately. The time uses your own timezone.

8. Check the cost line at the bottom of the dialog (see below), then click **Start Campaign** — or **Schedule Campaign** if you set a time.

### Check the estimated cost

Once you've chosen a template and an audience, the bottom-left of the **Create New Campaign** dialog shows the estimated cost of the send, priced per destination country, with the number of recipients (for example **Estimated cost** followed by the amount and "10 recipients"). While it is calculating it says **Estimating cost…**. What you see next depends on how the channel is billed — see [Channels](https://wabis.mintlify.site/workspace/channels/overview.md#how-the-channel-is-billed).

> [tab] Credit line (through wallet)
>
> A second line shows your **Wallet balance**.
>
> * If the balance can't cover the estimate, the line adds **Not enough balance**, the text turns red, and **Start Campaign** (or **Schedule Campaign**) is disabled. Recharge your wallet from the **Wallet** tab (see [Transactions](https://wabis.mintlify.site/workspace/transactions.md)), or choose a smaller audience.
> * If the line adds **Credit line is not attached yet**, the number's credit line isn't active, so the campaign can't be created. Open the WhatsApp card on [Channels](https://wabis.mintlify.site/workspace/channels/overview.md) and use **Retry** next to the credit line status.
>
> When you start or schedule the campaign, the estimated amount is held for it from your wallet. Whatever isn't spent is returned to you when the campaign ends — if it is cancelled, completed, or fails — or if you delete it.

> [tab] Direct (pay Meta)
>
> The second line says **Meta's rates, billed by Meta to your payment method. No wallet needed.** The estimate uses Meta's own rates with no markup.

### Estimate WhatsApp charges with the calculator

The **WhatsApp charges calculator** lets you estimate what WhatsApp will charge for a number of messages, before you build a campaign. It is a pop-up, not a separate page.

1. Go to **WhatsApp → Campaigns** and click **Calculate charges**, next to **Create Campaign**.

2. If your platform offers credit line billing, choose how you want to see prices with the **Credit line** / **Direct (pay Meta)** switch. A note under the switch explains each mode:

   * **Direct (pay Meta)** — Meta's own rates, billed by Meta to your payment method. No markup and no wallet needed.
   * **Credit line** — Meta's rate plus the platform markup, charged from your wallet.

   The calculator starts on your active channel's own billing type. If credit line isn't offered, only the direct view is shown and there is no switch.

3. Pick the **Destination country**. It starts on the country of your channel's WhatsApp number; if that can't be worked out, it uses the country of your browser's language, and otherwise the United States.

4. Pick the **WABA currency** — the billing currency of your WhatsApp Business Account. It starts on your account's currency when known, and otherwise falls back to your wallet currency, the destination country's currency, USD, or the first currency on the rate card. Only currencies that exist on the rate card are listed.

5. Enter the number of **Messages**, or drag the volume slider (up to 1,000,000). It starts at 10,000.

6. Read the table. It has one row per category — **Marketing**, **Utility**, **Authentication**, **Authentication International**, and **Service**:

   | Column | What it shows |
   | - | - |
   | **Category** | The message category. A market code in brackets, such as `(OTHER)`, means the rate came from a regional or default market because there is no rate for your exact country. |
   | **Meta rate** and **Markup %** | Credit line view only: Meta's rate and the markup the platform adds. |
   | **Rate per message** | The price for one message. If a currency code appears in brackets, there was no rate in your WABA currency, so the rate in that other currency is used. |
   | **Total** | The rate multiplied by the number of messages. |
   | **Total in** *(wallet currency)* **(wallet)** | Credit line view only: the total converted into your wallet currency at live exchange rates. |

   The last row, **All categories**, adds up every category. A category shows **No active rate** when the rate card has no price for it.

> [!NOTE]
>
> The calculator uses the rate card your platform administrator maintains — see WhatsApp Credit Line Pricing. Charges are for the same number of messages in every category, using the rates active today. The same calculator is on the public **Pricing** page of your platform, under **Estimate your WhatsApp messaging cost** → **Open pricing calculator**; there it starts on the platform's default billing view and a guessed country, since you aren't signed in to a channel.

### Send a carousel template

If you choose a [carousel template](https://wabis.mintlify.site/workspace/whatsapp/templates.md#create-a-carousel-template), the dialog adds a **Carousel cards** section and a card preview. Each card needs media, and values for any variables in its text or button links.

For every card:

* **Media** — the card uses the file saved with the template (**Using the file saved with the template.**). Click **Use a different file** to upload another image or video for this campaign only. If the template has no file for the card, **Upload a file for this card.** is required.
* **Card text variable** — enter a value for each variable in the card text.
* **Link value for button** — enter a value for each URL button that has a variable.

The **Start Campaign** (or **Schedule Campaign**) button stays disabled until every card has media and a real value for every variable. The template's sample values are never sent to customers.

> [!WARNING]
>
> If the template is a **Marketing** template, read the **Marketing Template Notice** in the dialog before you send.

### Manage a running campaign

1. Find the campaign in the table.
2. Open its row menu and choose **Pause** to stop sending (available while a campaign is active or processing), **Resume** to continue a paused campaign, or **Cancel** to cancel a scheduled one. Only scheduled campaigns can be cancelled in bulk. A campaign that is already sending can't be cancelled — pause it instead, because cancelling wouldn't stop messages that are already queued.
3. If a campaign was paused automatically, hover over its **paused** status to see the reason.

### Resend failed messages

When a completed or failed campaign has failed messages, open its row menu and choose **Resend**. A new campaign is created for only the recipients whose message failed, and a **Resend started** message tells you how many recipients it includes. The new campaign shows a **Resend** label.

If more failed recipients remain than one resend can cover, the message says so — resend again once the new campaign finishes.

### Review campaign performance

Click **View Details** on a campaign to open **Campaign Analytics**, and use **Export** to download the campaign report. Its tabs are:

> [tab] Campaign Details
>
> The campaign's **Type**, **Status**, **API Type**, **Campaign Type**, **Template**, **Language**, **Created** date, whether it was **Scheduled** or **Immediate**, and its **Description**.

> [tab] Performance
>
> The tiles at the top of the page show **Recipients**, **Messages Sent**, **Delivered**, **Read**, **Delivery Rate**, **Read Rate**, and **Failure Rate**. Check **Daily Performance** and the **Message Status Distribution** (Sent, Delivered, Read, Failed, Unknown).

> [tab] Error Analysis
>
> See the **Error Code**, **Error Message**, and **Occurrences** for failed messages.

> [tab] Target Audience
>
> Browse per-recipient results — each recipient's **Phone**, **Status**, **Status Description**, **Created**, and **Updated** time.

> [!TIP]
>
> Test with a small labeled audience first, send during business hours, and personalize with custom-field variables.

## Troubleshooting / Technical Notes

* **"Please select a template."** Choose an approved template. If the list is empty, create or sync templates in [Templates](https://wabis.mintlify.site/workspace/whatsapp/templates.md).
* **"Please select at least one label."** Pick an audience — All, Unlabeled, or specific labels. Manage labels in [Labels](https://wabis.mintlify.site/workspace/contacts/labels.md).
* **Recipients is 0.** The audience may be empty, or everyone in it is unsubscribed. Check the label and the **Include Unsubscribed** setting.
* **The Carousel cards section won't let me start.** Every card needs media and a value for each variable and URL button. Upload a file for any card marked **Upload a file for this card.**.
* **No Resend option in the menu.** It appears only for campaigns with status **completed** or **failed** that have at least one failed message.
* **Resume fails with an error.** The error message comes from WhatsApp — for example, the template may still be paused on WhatsApp. Check its status in [Templates](https://wabis.mintlify.site/workspace/whatsapp/templates.md).
* **Start Campaign is greyed out and the cost line is red.** Your credit line wallet can't cover the estimate (**Not enough balance**) or the credit line isn't attached yet. See "Check the estimated cost" above.
* **The calculator says "Pricing is not available right now."** The rate card couldn't be loaded. Close the calculator and try again; if it keeps happening, contact your platform administrator.
* **A category shows "No active rate".** The rate card has no price for that category in your country or region. Ask your platform administrator to add it.
* **"Only a scheduled campaign can be cancelled. Pause a running campaign instead."** Cancelling only works before a campaign starts sending. Use **Pause** on a running campaign.
* **A campaign shows Failed with a reason instead of staying on Processing.** When a campaign can't send at all — nothing to deliver, or every send failed — it now ends as **failed** with a reason you can read, and any unspent wallet hold is returned.
* **Many failed messages.** Open **Error Analysis** for the error codes. See [Templates](https://wabis.mintlify.site/workspace/whatsapp/templates.md#troubleshooting-/-technical-notes) for common causes.

### Common error codes

Failed messages show WhatsApp's error code. Codes marked *temporary* are retried automatically; *permanent* ones are not, because retrying won't help.

| Code | Meaning | Type |
| - | - | - |
| `131026` | Message undeliverable — not a WhatsApp number, the recipient hasn't accepted WhatsApp's terms, or they use an old WhatsApp version | Permanent |
| `131047` | More than 24 hours since the recipient last replied — a template message is required | Permanent |
| `131049` | Not delivered to keep the ecosystem healthy (a per-user marketing message limit) | Permanent |
| `131050` | The recipient opted out of marketing messages from this business | Permanent |
| `131042` | Payment method problem — no credit line, over the limit, or billing not set up | Permanent |
| `130403` | The business has blocked this recipient | Permanent |
| `131021` | Sender and recipient phone number are the same | Permanent |
| `100`, `131009` | A parameter is invalid or unsupported (check template variables) | Permanent |
| `131008` | A required parameter is missing | Permanent |
| `190`, `0` | The access token is invalid or has expired — reconnect the channel | Permanent |
| `368`, `131031` | The WhatsApp Business Account is restricted or disabled | Permanent |
| `130429` | Cloud API message throughput reached | Temporary |
| `131048` | Restrictions on messages from this number (spam or blocked-message rate) | Temporary |
| `131056` | Too many messages from this number to the same recipient in a short time | Temporary |
| `4`, `80007` | An API or account rate limit was reached | Temporary |

## Related docs

* [Templates](https://wabis.mintlify.site/workspace/whatsapp/templates.md)
* [Labels](https://wabis.mintlify.site/workspace/contacts/labels.md)
* [Contacts](https://wabis.mintlify.site/workspace/contacts/overview.md)
* [WhatsApp overview](https://wabis.mintlify.site/workspace/whatsapp/overview.md)
* [Channels](https://wabis.mintlify.site/workspace/channels/overview.md) — billing type and credit line status


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