Console

API Reference

The API Reference is the technical contract for the PaalChat API. Each page documents one endpoint - its path, method, required ability, parameters, and the responses it returns - with ready-to-run code in cURL, Node.js, PHP, Python, Ruby and Go.

For concepts and end-to-end workflows, see the Documentation. Every request uses a product token (Authentication); every error has the same shape (Errors and status codes).

Base URL https://whatsapp.paaltech.org/api/v1 Postman collection OpenAPI 3.1

Product

Who is calling.

GET Get product GET Get usage

Businesses

Your customers, addressed by your own external_id.

GET List businesses POST Create or update business GET Get business

WhatsApp

Connecting a business's WhatsApp, its state, numbers and templates.

GET List library templates POST Create connect link GET Get WhatsApp state GET List phone numbers GET List templates POST Create template POST Create template from library GET List template versions DELETE Delete template GET List account transfers POST Approve or reject a transfer DELETE Disconnect WABA

Messages

Sending messages and reading their status.

POST Send message GET Get message DELETE Cancel scheduled message GET Get Meta usage POST Estimate Meta cost

Billing

PaalChat's own plan, limits and invoices - never Meta's WhatsApp charges.

GET List plans GET Get billing POST Pay invoice

Channels

SMS and email next to WhatsApp, provider health, and notifications that fail over between channels.

GET Get provider health GET List channels PUT Set up SMS or email DELETE Turn off SMS or email POST Send notification GET Get notification

Campaigns

Segments, scheduled messages and broadcasts to many contacts.

GET List segments POST Create segment POST Preview segment GET Get segment PATCH Update segment DELETE Delete segment GET List segment contacts GET List campaigns POST Create campaign GET Get campaign POST Preview campaign POST Launch campaign POST Pause, resume or cancel campaign

Automations

Trigger -> conditions -> steps, per contact, with waits.

GET List automations POST Create automation GET Get automation PATCH Update automation DELETE Delete automation GET List automation runs

Compliance

Consent, opt-outs, notification preferences and the suppression list.

DELETE Erase contact GET Get consent and preferences PUT Record consent PUT Set notification preferences GET List suppressed numbers POST Suppress a number DELETE Remove a suppressed number POST Export business data GET Get export

Sandbox

Simulations for sandbox businesses - test keys only.

POST Simulate an incoming message POST Simulate a delivery status

Inbox

The PaalChat inbox for a business's staff - signed in from your product.

POST Sign staff in to the inbox GET List inbox members DELETE Remove inbox access

Media

Files - incoming attachments and uploads to send - behind short-lived signed links.

POST Upload media GET Get media

Contacts

The people a business talks to, with your own fields and tags.

GET List contacts POST Create or update contact GET Get contact PATCH Update contact GET List contact fields PUT Define a contact field

Conversations

A business's conversations with its contacts - read and work them.

GET List conversations GET Get conversation PATCH Update conversation GET List conversation messages GET List notes POST Add note

Callbacks

Signed events PaalChat POSTs to your product.

Event message.received Event message.status Event template.status Event whatsapp.connection Event contact.created Event contact.updated Event conversation.created Event conversation.updated Event media.updated Event contact.consent Event campaign.updated Event automation.action Event notification.updated