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

# WhatsApp API

> Send approved WhatsApp templates at scale with personalized text, media, locations, and carousel cards

The Pro Plus WhatsApp API lets you discover active connectors, inspect approved Meta templates, and send template messages to one or many recipients.

## Base URL

The WhatsApp API uses the same base URL as the SMS API:

```bash theme={null}
export WHATSAPP_BASE_URL="https://app.notify.ng"
```

All WhatsApp endpoints use the following route prefix:

```text theme={null}
/api/whatsapp/v1
```

## Quick start

**1. Set up authentication**

Use your client ID as the HTTP Basic username and your API key as the password.

**2. Choose an active connector**

[List your active connectors](https://docs.ruachnet.com/whatsapp/connectors/get-connectors.md) and copy the connector's `phoneNumber` and `whatsappBusinessAccountId`.

**3. Find an approved template**

[List templates](https://docs.ruachnet.com/whatsapp/templates/list-templates.md) for the WhatsApp Business Account and copy the template's `metaTemplateId`.

**4. Send a message**

Use a [bulk payload](https://docs.ruachnet.com/whatsapp/messages/send-bulk.md) when all recipients receive the same values, or a [custom payload](https://docs.ruachnet.com/whatsapp/messages/send-custom.md) for per-recipient personalization.

## Message capabilities

> [card] [Bulk payloads](https://docs.ruachnet.com/whatsapp/messages/send-bulk.md)
>
> Send one set of template variables to a comma-separated recipient list.

> [card] [Custom payloads](https://docs.ruachnet.com/whatsapp/messages/send-custom.md)
>
> Supply different header and body values for each recipient.

> [card] [Media and locations](https://docs.ruachnet.com/whatsapp/messages/media-and-location.md)
>
> Send approved templates with image, video, PDF, or location headers.

> [card] [Carousel cards](https://docs.ruachnet.com/whatsapp/messages/carousel.md)
>
> Populate media, body variables, and dynamic URL values for each template card.

> [!WARNING]
>
> Messages must use a template already associated with the authenticated WhatsApp Business Account. A template that is pending or rejected cannot be sent.

## Naming conventions

Request field names are case-sensitive. In particular, the API contract spells the recipient field `RecieverNumber`. Use that spelling exactly, even though `ReceiverNumber` is the conventional English spelling.


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