Skip to main content
Converso CWA Logo
CWADocumentation
Quick startAPI ConsoleOpen panel
CWA API v3 | Reference
CWA API v3 | Reference
OverviewAll endpointsSupport matrix API ConsoleGetting startedQuick startGetting startedAuthenticationCore conceptsInstances & messagesGuidesSend a text messageWebhooksWebhooksResourcesErrors & rate limitsResourcesTroubleshooting
Connection & Presence (3)GETConnect a sessionGETRead connection statePOSTSet account presence
Send messages (12)POSTSend a text messagePOSTSend an image, video, document, or audioPOSTSend a video notePOSTSend a voice notePOSTPublish a WhatsApp statusPOSTSend a stickerPOSTSend a locationPOSTSend contact cardsPOSTAdd or remove a reactionPOSTSend a pollPOSTSend a listPOSTSend buttons (channel-dependent)
Chats & history (10)POSTList conversationsGETFind a saved chatPOSTArchive or unarchive a chatPOSTMark a chat unreadPOSTList stored messagesPOSTEdit a messagePOSTMark messages readDELDelete a message for everyonePOSTDownload message mediaPOSTSend typing or recording presence
Contacts (6)POSTList saved contactsPOSTCheck WhatsApp numbersPOSTBlock or unblock a contactPOSTFetch a contact picturePOSTFetch a business profilePOSTList message delivery updates
Groups & invites (16)POSTCreate a groupGETList joined groupsGETFetch group informationPOSTUpdate a group namePOSTUpdate a group descriptionPOSTUpdate a group picturePOSTUpdate group permissionsPOSTSet disappearing messagesGETList group participantsPOSTManage group participantsGETGet a group invite linkGETInspect an invitePOSTSend group invitationsPOSTJoin through an invitePOSTRotate a group invite codeDELLeave a group
Your profile (7)POSTFetch account or contact profilePOSTUpdate your profile namePOSTUpdate your about textPOSTUpdate your profile pictureDELRemove your profile pictureGETRead privacy settingsPOSTUpdate privacy settings
Business catalogs (2)POSTFetch a business catalogPOSTFetch catalog collections
Labels (2)GETList labelsPOSTAssign or remove a label
Calls (1)POSTCall offer placeholder
Proxy (2)POSTConfigure the instance proxyGETRead proxy configuration
Stored media (2)POSTFind stored mediaPOSTGet a stored media URL

v3.0.0 · 63 Endpoints
Reviewed 2026-09-30

Converso CWA Logo

Converso WhatsApp API V3

Build WhatsApp integrations with sessions, messaging, groups, media, presence, and event delivery. Start with a connected instance, then use the reference for exact request contracts.

v3.0.0

63

Customer API operations

11

Resource groups

2 headers

Customer API authentication

Start with a connected instance

Use a provisioned instance and a number you control.

1

Add your credentials

Create an instance in the panel. Send X-CWA-Key and X-CWA-Instance on customer API requests.

2

Check or connect the session

Read connection/status. If closed, call session/connect and pair WhatsApp before sending.

3

Send and keep the message key

Start with a text message. Save key.id, key.remoteJid and key.fromMe for follow-up operations.

Quick startExplore endpointsOpen API Console

Example request

Set your environment variables and replace sample IDs before use.

curl
curl --fail-with-body -X POST "$CWA_BASE_URL/messages/text/send" \
  -H "X-CWA-Key: $CWA_KEY" \
  -H "X-CWA-Instance: $CWA_INSTANCE" \
  -H 'Content-Type: application/json' \
  --data '{"number":"15551234567","text":"Hello from Converso"}'
Some operations have implementation limits: the call route is a placeholder, and button sending is unavailable on the CWA transport. Read the notes on each endpoint.
Quick startAuthenticationWebhooksTroubleshooting

Connection & Presence

3 documented operations

Send messages

12 documented operations

Chats & history

10 documented operations

Contacts

6 documented operations

Groups & invites

16 documented operations

Your profile

7 documented operations

Business catalogs

2 documented operations

Labels

2 documented operations

Calls

1 documented operations

Proxy

2 documented operations

Stored media

2 documented operations

NextQuick start →

Examples use illustrative values. Confirm behavior against your deployed CWA V3 version before production use.