💻 WhatsApp API
🔽 POST /public/whatsapp/message/scheduled
– Send a Programmed Template Message
POST /public/whatsapp/message/scheduled
– Send a Programmed Template MessageSchedules a WhatsApp template message to be sent at a specific future time.
Click to expand
🔹 Request Example
{
"recipient": "+5511999999999",
"templateName": "appointment_reminder",
"language": "en",
"parameters": ["Pedro", "3:00 PM"],
"sendAt": "2025-04-10T15:00:00Z"
}
🔽 DELETE /public/whatsapp/message/scheduled/{scheduledMessageId}
– Cancel a Programmed Message
DELETE /public/whatsapp/message/scheduled/{scheduledMessageId}
– Cancel a Programmed MessageCancels a scheduled message using its ID.
Click to expand
🔹 Example
curl -X DELETE https://api.vambe.me/public/whatsapp/message/scheduled/abc123 \
-H "x-api-key: your api key"
🔽 POST /public/whatsapp/message
– Send a Template Message
POST /public/whatsapp/message
– Send a Template MessageSends a WhatsApp message using a pre-approved template immediately.
Click to expand
🔹 Request Body Example
{
"recipient": "+5511999999999",
"template": "template_id",
"parameters": ["50% OFF", "today"]//Variables defined in the template
}
🔽 POST /public/whatsapp/message/unstructured
– Send a Template Message with Unstructured Data
POST /public/whatsapp/message/unstructured
– Send a Template Message with Unstructured DataSends a message using free-form (unstructured) content within a template.
Click to expand
🔹 Request Body Example
{
"recipient": "+5511999999999",
"message": "Hi Pedro, your package will arrive today. 🎉"
}
# 🔽 POST /public/whatsapp/message/template
– Send a Template Message
POST /public/whatsapp/message/template
– Send a Template MessageSimilar 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
POST /public/whatsapp/message/note
– Send a Note MessageSends 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
POST /public/whatsapp/contact/upsert
– Upsert User InformationCreates or updates user information such as tags, name, and custom metadata.
Click to expand
🔹 Request Body Example
{
"phone": "+5511999999999",
"name": "Pedro",
"tags": ["lead", "newsletter"],
"metadata": {
"signup_source": "website"
}
}
🔽 GET /public/whatsapp/contact
– Get Contacts
GET /public/whatsapp/contact
– Get ContactsReturns a list of WhatsApp contacts associated with your account.
Click to expand
🔹 Example
curl -X GET https://api.vambe.me/public/whatsapp/contact \
-H "x-api-key: YOUR_API_KEY"
Updated 16 days ago