WhatsAppOverview

WhatsApp API Overview

The ChumiAI WhatsApp API allows you to programmatically send messages, manage conversations, and sync templates — all through simple REST endpoints authenticated with your API key.

Getting Started

Before using the WhatsApp API, make sure you have:

  • A ChumiAI account with an active business
  • A connected WhatsApp Business integration
  • A valid API key with WhatsApp scopes enabled

What You Can Do

The WhatsApp API supports the following operations:

Template Messaging

Send pre-approved messages to customers

  • Single Messages: Send a template message to one recipient with dynamic parameters.
  • Bulk via File Upload: Upload an Excel or CSV file to message hundreds of recipients at once.
  • Bulk via Contact Groups: Send templates to all contacts in a ChumiAI contact group.

Conversations

Manage and retrieve chat history

  • Retrieve Conversations: Fetch full conversation history for any customer.
  • Webhooks: Get real-time notifications when new messages arrive.

Template Management

Sync and manage your WhatsApp templates

  • List Templates: View all approved templates available for your integration.
  • Sync Templates: Pull the latest template updates from Meta into ChumiAI.

Authentication

All WhatsApp API requests require your API key passed in the X-API-Key HTTP header.

Example Request
curl -X GET "https://api.chumiai.app/api/v1/whatsapp/templates" \
   -H "X-API-Key: YOUR_API_KEY" \
   -H "Content-Type: application/json"

Your API key must have the appropriate WhatsApp scopes enabled. You can manage scopes in Settings > Developer Settings > API Keys in the ChumiAI Client Portal.

Available Endpoints

GET/api/v1/whatsapp/templates
List all approved message templates
POST/api/v1/whatsapp/send-template
Send a template message to a single recipient
POST/api/v1/whatsapp/bulk-import-messages
Bulk send via Excel/CSV file upload
POST/api/v1/whatsapp/send-template-to-group
Bulk send to a contact group
GET/api/v1/whatsapp/bulk-jobs/{jobId}/status
Check bulk job progress
GET/api/v1/whatsapp/bulk-jobs
List bulk job history

Rate Limits

WhatsApp enforces messaging rate limits based on your business tier. High-volume template sends are processed in the background and may be throttled. Use the bulk job monitoring endpoints to track delivery progress.

Next Steps