API reference

Base URL https://api.waasl.io/v1 · sandbox https://stage.api.waasl.io/v1 · download the OpenAPI 3.1 spec

59endpoints

25available

9beta

25coming soon

12webhook events

Available live in the Waasl platformBeta usable, shape may still changeComing soon designed, on the roadmap

Workspace

The workspace your API key belongs to, and its connected channels.

GET/meInspect the current API keyAvailable GET/workspaceRetrieve the workspaceAvailable GET/channelsList channelsAvailable GET/channels/{channel_id}Retrieve a channelBeta

Contacts

People you talk to. A contact has one or more channel identities (WhatsApp number, Instagram handle, email…).

GET/contactsList contactsAvailable POST/contactsCreate or update a contactBeta POST/contacts/importImport contacts in bulkAvailable GET/contacts/{contact_id}Retrieve a contactAvailable PATCH/contacts/{contact_id}Update a contactAvailable DELETE/contacts/{contact_id}Delete a contactComing soon POST/contacts/{contact_id}/mergeMerge contactsComing soon GET/custom-fieldsList custom fieldsComing soon POST/custom-fieldsCreate a custom fieldComing soon GET/tagsList tagsComing soon GET/stagesList lifecycle stagesAvailable

Conversations

Threads between a contact and your team on one channel — routing, assignment, lifecycle stage and closing.

GET/conversationsList conversationsAvailable GET/conversations/{conversation_id}Retrieve a conversationAvailable POST/conversations/{conversation_id}/assignAssign a conversationAvailable POST/conversations/{conversation_id}/closeClose a conversationAvailable POST/conversations/{conversation_id}/reopenReopen a conversationAvailable PUT/conversations/{conversation_id}/stageSet the lifecycle stageAvailable POST/conversations/{conversation_id}/handoverHand over between bot and humanBeta POST/conversations/{conversation_id}/snoozeSnooze a conversationComing soon POST/conversations/{conversation_id}/notesAdd an internal noteAvailable

Messages

Send and read messages. Free-form messages need an open 24-hour WhatsApp window; outside it, send an approved template.

POST/messagesSend a message to a phone numberBeta GET/messages/{message_id}Retrieve a messageBeta GET/conversations/{conversation_id}/messagesList messages in a conversationAvailable POST/conversations/{conversation_id}/messagesReply in a conversationAvailable

Templates

WhatsApp message templates — create, submit for Meta review and track their status.

GET/whatsapp/templatesList WhatsApp templatesAvailable POST/whatsapp/templatesCreate and submit a templateAvailable GET/whatsapp/templates/{template_id}Retrieve a templateBeta DELETE/whatsapp/templates/{template_id}Delete a templateAvailable

Media

Upload files once, then reference them by `media_id` in messages.

POST/mediaUpload a fileAvailable GET/media/{media_id}Download a fileAvailable

Users & teams

The agents in your workspace and the teams they belong to.

GET/usersList usersAvailable PUT/users/{user_id}/availabilitySet a user's availabilityComing soon GET/teamsList teamsComing soon

Automation

Workflows built in the Waasl console — list them, pause or publish, and trigger them from your systems.

GET/workflowsList workflowsAvailable POST/workflows/{workflow_id}/statusPublish or pause a workflowAvailable POST/workflows/{workflow_id}/runsTrigger a workflowComing soon

Broadcasts

Send an approved template to an audience, with throttling and per-recipient delivery reporting.

GET/broadcastsList broadcastsComing soon POST/broadcastsCreate a broadcastComing soon GET/broadcasts/{broadcast_id}Retrieve a broadcastComing soon POST/broadcasts/{broadcast_id}/cancelCancel a broadcastComing soon

AI

AI agents, reply drafting and conversation summaries.

GET/ai/agentsList AI agentsBeta POST/conversations/{conversation_id}/ai/composeDraft a reply with AIComing soon POST/conversations/{conversation_id}/ai/summarySummarise a conversationComing soon POST/ai/knowledge-sourcesAdd a knowledge sourceComing soon

Analytics

Volume, response times and delivery funnels for reporting.

GET/analytics/overviewInbox snapshotBeta GET/analytics/conversationsConversation metricsComing soon GET/analytics/messagesDelivery funnelComing soon

Webhooks

Register HTTPS endpoints to receive events in real time.

GET/webhook-endpointsList webhook endpointsComing soon POST/webhook-endpointsRegister a webhook endpointComing soon PATCH/webhook-endpoints/{endpoint_id}Update a webhook endpointComing soon DELETE/webhook-endpoints/{endpoint_id}Delete a webhook endpointComing soon POST/webhook-endpoints/{endpoint_id}/testSend a test eventComing soon GET/webhook-endpoints/{endpoint_id}/deliveriesList recent deliveriesComing soon

Billing

Messaging wallet balance and usage.

GET/walletRetrieve the messaging walletBeta GET/usageUsage for a periodComing soon

Webhook events

EVENTmessage.receivedBeta EVENTmessage.sentBeta EVENTmessage.status_updatedBeta EVENTconversation.createdComing soon EVENTconversation.assignedComing soon EVENTconversation.closedBeta EVENTconversation.stage_changedComing soon EVENTcontact.createdComing soon EVENTcontact.updatedComing soon EVENTtemplate.status_updatedBeta EVENTchannel.status_updatedComing soon EVENTbroadcast.completedComing soon