API Documentation

Base URL & Endpoint Structure

All WAB2C API requests are made against the following base URL. Your tenant subdomain is part of the URL path to isolate your workspace data.

Base URL:      https://app.wab2c.com/api/
Tenant Path:   https://app.wab2c.com/api/{tenant}/
Example:       https://app.wab2c.com/api/mycompany/contacts

Authentication

All API requests must include a Bearer token in the Authorization header. Generate your API token from the API Management section in your WAB2C tenant settings.

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Token Abilities (Permissions)

API tokens have granular permissions. Configure abilities when generating your token to follow the principle of least privilege.

Send Media Message

Send Template Message

curl -X POST "https://app.wab2c.com/api/{tenant}/messages/template" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "phone_number": "+923001234567",
    "template_name": "order_confirmation",
    "template_language": "en",
    "field_1": "Ahmed",
    "field_2": "PKR 4,500",
    "field_3": "12 Feb 2026"
  }'

Send Auth Template (OTP)

Send WhatsApp authentication templates for OTP verification. Supports auto-generated OTPs, manual OTPs, and automatic contact creation during signup flows.

{
  "phone_number": "+923451234567",
  "template_name": "verify_otp",
  "template_language": "en",
  "field_1": "847293"
}

curl -X POST "https://app.wab2c.com/api/{tenant}/messages/template" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "phone_number": "+923331234567",
    "template_name": "verify_otp",
    "template_language": "en",
    "auto_generate_otp": true,
    "contact": {
      "firstname": "Fatima",
      "lastname": "Khan",
      "email": "fatima.khan@example.com"
    }
  }'

{
  "success": true,
  "message": "Template sent successfully",
  "data": {
    "message_id": "wamid.HBgLOTIzMzMxMjM0NTY3...",
    "phone_number": "+923331234567",
    "otp": "847293",
    "status": "sent"
  }
}

Message Status

{
  "success": true,
  "data": {
    "message_id": "wamid.HBgLOTIzMDAxMjM0NTY3...",
    "status": "delivered",
    "timestamp": "2026-02-17T10:30:00Z"
  }
}

Create Contact

curl -X POST "https://app.wab2c.com/api/{tenant}/contacts" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "firstname": "Ali",
    "lastname": "Raza",
    "phone": "+923211234567",
    "email": "ali.raza@example.com",
    "company": "Lahore Traders",
    "city": "Lahore"
  }'

List Contacts

Update Contact

PUT /api/{tenant}/contacts/142

{
  "firstname": "Ali",
  "lastname": "Ahmed",
  "company": "Karachi Electronics",
  "city": "Karachi"
}

Delete Contact

Manage contact and lead statuses programmatically. Statuses help categorize contacts by pipeline stage (e.g., New, Qualified, Converted, Closed).

POST /api/{tenant}/statuses

{
  "name": "Interested",
  "color": "#22c55e",
  "description": "Lead has shown interest in our services"
}

Manage lead and contact sources to track where your contacts originated (e.g., Website, Facebook Ad, Referral, Walk-in).

POST /api/{tenant}/sources

{
  "name": "Facebook Ads - Lahore Campaign",
  "description": "Leads from Feb 2026 Facebook campaign targeting Lahore"
}

Organize contacts into groups for targeted campaign segmentation and bulk operations.

POST /api/{tenant}/groups

{
  "name": "VIP Customers - Islamabad",
  "description": "High-value customers from Islamabad region"
}

Receive real-time notifications when events occur in your WAB2C tenant. Configure a webhook URL in Tenant Settings to receive instant updates for contacts, statuses, and sources.

Webhook Events

Webhook Handler Examples

# Webhook events are sent TO your endpoint.
# Test with:
curl -X POST "https://your-app.com/api/wab2c-webhook" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "contact.created",
    "data": {
      "id": 142,
      "firstname": "Zain",
      "phone": "+923451234567"
    }
  }'

Connect your WooCommerce store to WAB2C to send automatic WhatsApp order notifications, shipping updates, and abandoned cart reminders.

Available Webhook Topics

eCommerce Webhook Dashboard

The Webhook Dashboard in your WAB2C tenant provides a centralized interface to create, monitor, and manage all eCommerce webhook integrations.

Webhook URL Format:
https://app.wab2c.com/api/webhooks/{webhook_id}

Use this URL as the Delivery URL in WooCommerce, Shopify, or any eCommerce platform.

Rate Limits

API rate limits are enforced per token. Exceeding limits returns a 429 Too Many Requests response.

Error Codes

{
  "success": false,
  "message": "Error description",
  "errors": {
    "phone_number": ["The phone number field is required."],
    "template_name": ["The selected template was not found."]
  }
}

Best Practices