Skip to main content
All endpoints require authentication.

Endpoints

List Channels

GET /api/channels

Create Channel

POST /api/channels
Body
FieldTypeRequiredDescription
namestringYesLabel for the channel
typestringYeswhatsapp, gmail, twitter, web, telegram
apiKeystringDependsAPI key from your WhatsApp provider
accessTokenstringDependsOAuth access token (Gmail, Twitter)

Get Channel

GET /api/channels/:id

Update Channel

PATCH /api/channels/:id

Delete Channel

DELETE /api/channels/:id
Deleting a channel removes it from all associated bots.

WhatsApp — Send Message

POST /api/whatsapp/send
Body
FieldTypeDescription
tostringRecipient phone number (with country code, no +)
messagestringMessage text
channelIdnumberThe WhatsApp channel to send from

Send Image

POST /api/whatsapp/send-image
FieldTypeDescription
tostringRecipient phone number
imageUrlstringPublicly accessible image URL
captionstringOptional caption
channelIdnumberChannel to send from

List Templates

GET /api/whatsapp/templates
Returns approved WhatsApp message templates for the linked account.

Health Check

GET /api/whatsapp/health
Returns connectivity status of the WhatsApp integration.