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

# 💻 WhatsApp API

### 🔽 `POST /public/whatsapp/message/scheduled` – Send a Programmed Template Message

Schedules a WhatsApp template message to be sent at a specific future time.

Click to expand

### 🔹 Request Example

<CodeGroup>
  ```bash bash theme={null}
  {
    "recipient": "+5511999999999",
    "templateName": "appointment_reminder",
    "language": "en",
    "parameters": ["Pedro", "3:00 PM"],
    "sendAt": "2025-04-10T15:00:00Z"
  }
  ```
</CodeGroup>

***

### 🔽 `DELETE /public/whatsapp/message/scheduled/{scheduledMessageId}` – Cancel a Programmed Message

Cancels a scheduled message using its ID.

Click to expand

### 🔹 Example

<CodeGroup>
  ```bash bash theme={null}
  curl -X DELETE https://api.vambe.me/public/whatsapp/message/scheduled/abc123 \
    -H "x-api-key: your api key"
  ```
</CodeGroup>

***

### 🔽 `POST /public/whatsapp/message` – Send a Template Message

Sends a WhatsApp message using a pre-approved template immediately.

Click to expand

### 🔹 Request Body Example

<CodeGroup>
  ```bash bash theme={null}
  {
    "recipient": "+5511999999999",
    "template": "template_id",
    "parameters": ["50% OFF", "today"]//Variables defined in the template
  }
  ```
</CodeGroup>

***

### 🔽 `POST /public/whatsapp/message/unstructured` – Send a Template Message with Unstructured Data

Sends a message using free-form (unstructured) content within a template.

Click to expand

### 🔹 Request Body Example

<CodeGroup>
  ```bash bash theme={null}
  {
    "recipient": "+5511999999999",
    "message": "Hi Pedro, your package will arrive today. 🎉"
  }
  ```
</CodeGroup>

***

## # 🔽 `POST /public/whatsapp/message/template` – Send a Template Message

Similar to the general template sender, this may be tied to a different handler. Use when required by template-specific logic.

***

### 🔽 `POST /public/whatsapp/message/note` – Send a Note Message

Sends a simple, non-template, free-text message to a WhatsApp contact.

***

## 📇 WhatsApp Contact Endpoints

Endpoints to manage your WhatsApp contacts.

***

### 🔽 `POST /public/whatsapp/contact/upsert` – Upsert User Information

Creates or updates user information such as tags, name, and custom metadata.

Click to expand

### 🔹 Request Body Example

<CodeGroup>
  ```bash bash theme={null}
  {
    "phone": "+5511999999999",
    "name": "Pedro",
    "tags": ["lead", "newsletter"],
    "metadata": {
      "signup_source": "website"
    }
  }
  ```
</CodeGroup>

***

### 🔽 `GET /public/whatsapp/contact` – Get Contacts

Returns a list of WhatsApp contacts associated with your account.

Click to expand

### 🔹 Example

<CodeGroup>
  ```bash bash theme={null}
  curl -X GET https://api.vambe.me/public/whatsapp/contact \
    -H "x-api-key: YOUR_API_KEY"
  ```
</CodeGroup>

***

***

[📱 WhatsApp QR](/docs/whatsapp-qr)

[📬 Get Messages](/docs/get-messages)

Ask AI

* [Table of Contents](#)

* * * [🔽 POST /public/whatsapp/message/scheduled – Send a Programmed Template Message](#-post-publicwhatsappmessagescheduled--send-a-programmed-template-message)
    * [🔽 DELETE /public/whatsapp/message/scheduled/\{scheduledMessageId} – Cancel a Programmed Message](#-delete-publicwhatsappmessagescheduledscheduledmessageid--cancel-a-programmed-message)
    * [🔽 POST /public/whatsapp/message – Send a Template Message](#-post-publicwhatsappmessage--send-a-template-message)
    * [🔽 POST /public/whatsapp/message/unstructured – Send a Template Message with Unstructured Data](#-post-publicwhatsappmessageunstructured--send-a-template-message-with-unstructured-data)

  * [# 🔽 POST /public/whatsapp/message/template – Send a Template Message](#--post-publicwhatsappmessagetemplate--send-a-template-message)

  * * [🔽 POST /public/whatsapp/message/note – Send a Note Message](#-post-publicwhatsappmessagenote--send-a-note-message)

  * [📇 WhatsApp Contact Endpoints](#-whatsapp-contact-endpoints)

  * * [🔽 POST /public/whatsapp/contact/upsert – Upsert User Information](#-post-publicwhatsappcontactupsert--upsert-user-information)
    * [🔽 GET /public/whatsapp/contact – Get Contacts](#-get-publicwhatsappcontact--get-contacts)