Mon-Fri 10am - 6pm
Base URL for your account: https://cpaas.studio
Send WhatsApp template, session and media messages, follow their status, run campaigns, manage contacts, groups and opt-outs, read your allowance and usage, and receive signed webhooks. Postman collection: /api-documentation/whatsapp/postman.json
-
Send Template
POST /api/whatsapp/v1/send/templateSend an approved template — the only way to start a conversation or write outside the 24-hour window. Authentication (OTP) templates take `code`. -
Send Session Message
POST /api/whatsapp/v1/send/sessionSend free-form text (or an interactive message) inside the 24-hour customer-service window — i.e. within 24 hours of the contact's last message to you. -
Send Media
POST /api/whatsapp/v1/send/mediaSend an image, video, audio, document or sticker inside the 24-hour window — from your media library (media) or an https link. -
Message Status
GET /api/whatsapp/v1/messages/{ref}One message by the ref the send returned: our status, its error (mapped status + provider_code), billing, and every timestamp. -
Create Campaign
POST /api/whatsapp/v1/campaignsCreate a campaign and launch it now (or schedule it with schedule_at). Recipients excluded by opt-out, blacklist or inactive status are recorded as skipped and cost nothing. -
List Campaigns
GET /api/whatsapp/v1/campaignsYour campaigns, newest first. -
Get Campaign
GET /api/whatsapp/v1/campaigns/{uid}One campaign: status, counters (the funnel), exclusions by reason, money. -
Pause Campaign
POST /api/whatsapp/v1/campaigns/{uid}/pauseStop sending after the batch in flight. Messages already handed to Meta still deliver. -
Resume Campaign
POST /api/whatsapp/v1/campaigns/{uid}/resumeContinue a paused campaign where it stopped (after a top-up, for paused_no_balance). -
Cancel Campaign
POST /api/whatsapp/v1/campaigns/{uid}/cancelCancel: messages not yet sent become cancelled and are never charged. -
List Numbers
GET /api/whatsapp/v1/channelsActive, non-deleted WhatsApp numbers available for selection, with their uid, quality rating, messaging tier and status. A key restricted to one number sees only that one when active. Use number details to inspect a disabled number. -
List Templates
GET /api/whatsapp/v1/templatesYour templates with their status and whether they can be sent now. -
Balance
GET /api/whatsapp/v1/balanceYour live plan and the allowance left per category, in ₹ and in whole messages (own pot, and with the shared pot). -
Usage Report
GET /api/whatsapp/v1/reports/usageDaily counts and charges per category (at most 93 days per request). Kept indefinitely, after message details age out. -
Upload Media
POST /api/whatsapp/v1/mediaUpload a file to your media library (multipart form field `file`). Image 5 MB, video / audio 16 MB, document 100 MB, sticker 500 KB; the type is detected from the file itself. -
List Media
GET /api/whatsapp/v1/mediaYour library, with usage against your quota. -
Get Media
GET /api/whatsapp/v1/media/{uid}One file's metadata. -
Delete Media
DELETE /api/whatsapp/v1/media/{uid}Delete a file — refused (409) while a template or an active campaign uses it. -
List Contacts
GET /api/whatsapp/v1/contactsYour contacts. -
Create Contact
POST /api/whatsapp/v1/contactsAdd a contact with its opt-in record. consent_source and consent_evidence are required — Meta requires businesses to hold an opt-in for every number they message. -
Get Contact
GET /api/whatsapp/v1/contacts/{phone}One contact, addressed by phone. Add ?channel={uid} when the number is a contact on several of your numbers. -
Update Contact
PUT/POST /api/whatsapp/v1/contacts/{phone}Change the name and attributes (merge=true merges attributes instead of replacing them). The phone and the consent record cannot change. -
Delete Contact
DELETE /api/whatsapp/v1/contacts/{phone}Remove the contact. Its messages, opt-outs and consent history are kept. -
List Groups
GET /api/whatsapp/v1/groupsYour contact groups (campaign audiences). -
Create Group
POST /api/whatsapp/v1/groupsA new group. -
Update Group
PUT/POST /api/whatsapp/v1/groups/{uid}Rename. -
Delete Group
DELETE /api/whatsapp/v1/groups/{uid}Delete the group (its contacts stay). Refused while an active campaign targets it. -
Add Group Members
POST /api/whatsapp/v1/groups/{uid}/membersAdd existing contacts by phone (up to 10,000 per call). -
Remove Group Members
DELETE /api/whatsapp/v1/groups/{uid}/membersRemove contacts from the group by phone. -
List Opt-outs
GET /api/whatsapp/v1/optoutsNumbers that opted out, per number and scope. -
Add Opt-out
POST /api/whatsapp/v1/optoutsRecord an opt-out (marketing = marketing templates blocked; all = every message you start). -
Lift Opt-out
DELETE /api/whatsapp/v1/optoutsLift an opt-out — only when the person asked to receive messages again; `note` (10+ characters) records why. -
Webhook: message
POST https://your-server.example/your-webhook (we call you)A contact sent a message to your number (text, media, button / list reply, location, …). Sent only for a message that was stored (and billed, if inbound messages are charged on your plan). -
Webhook: status
POST https://your-server.example/your-webhook (we call you)A message you sent moved forward: sent, delivered, read — or failed. One per change; a status never moves backwards. error is present only for failed. -
Webhook: template_status
POST https://your-server.example/your-webhook (we call you)Meta changed one of your templates: approved / rejected / paused / disabled (kind = status), re-categorised (kind = category), or a quality rating change (kind = quality). -
Webhook: optout
POST https://your-server.example/your-webhook (we call you)A contact opted out: replied STOP / UNSUBSCRIBE (source keyword), or was added on the opt-out page (manual_optout) or through the API (api_optout). scope is marketing or all. -
Message statuses and errors
GET /api/whatsapp/v1/messages/{ref} → error.codeThe error codes a failed message carries (Message Status, the status webhook). Column 3 says whether the allowance is returned when a message fails with that code. provider_code (Meta's raw code) is returned alongside for your logs.