Meowsapp WhatsApp API
Documentation menu

Start here

Guides

API reference

More

Reference

API reference

Base URL https://api.meowsapp.com. JSON in, JSON out, one bearer token. Every endpoint below links to its parameters, samples and error codes.

Conventions

Base URLhttps://api.meowsapp.com
AuthenticationAuthorization: Bearer <token> (or X-V3-Secret) on everything except /health*. See Authentication.
Content typeapplication/json; multipart/form-data only for media uploads.
Where parameters goGET routes and POST /start: query string. Other POST routes: JSON body.
Success200 with the documented body. Sends return {"status": "sent", "messageId"}.
ErrorsAlways {"error": "<message>"} with a 4xx/5xx status. See Errors.
TimestampsRFC 3339, UTC.
IdentifiersclientId (letters+digits), to (LID / +phone / JID), chatRoomId, messageId. See Core concepts.
A complete request
curl -X POST "https://api.meowsapp.com/check-state" \
  -H "Authorization: Bearer $SN_TOKEN" -H "Content-Type: application/json" \
  -d '{ "clientId": "acmemain" }'

Endpoint index

Sessions10 routes

POST/startStart or resume a session
GET/qrGet the pairing QR
POST/pair-phonePair with a phone-number code
POST/check-stateCheck connection state
GET/clientsList sessions
POST/set-webhookSet or clear the webhook
POST/set-org-idEnable hosted history (workspace id)
POST/set-api-secretPer-session API secret
POST/set-enable-group-aiEnable group messages
POST/disconnectUnlink and delete a session

Messages11 routes

POST/send-messageSend text
POST/send-media-messageSend media by URL
POST/send-media-messageSend media by upload
POST/send-poll-messageSend a poll
POST/send-interactive-messageSend buttons
POST/send-reactionReact to a message
POST/edit-messageEdit a sent message
POST/send-locationSend a location
POST/send-contactSend a contact card
POST/send-typingTyping indicator
POST/delete-messageDelete a message

Chats & contacts6 routes

POST/mark-readSend read receipts
POST/mark-unreadMark a chat unread
POST/user-infoLook up a contact
POST/check-owner-lidIs this number on WhatsApp?
GET/profile-pictureProfile picture
POST/refresh-avatarsBackfill profile pictures

Groups6 routes

POST/get-groupsList groups
POST/get-group-participantsGroup details & members
POST/create-groupCreate a group
POST/update-group-membersAdd, remove, promote, demote
POST/group-invite-linkInvite link
POST/leave-groupLeave a group

Hosted inbox & media library6 routes

GET/chatroomsList chats
GET/chatrooms/{chatRoomId}/messagesChat history
GET/chatrooms/{chatRoomId}/messages/{messageId}/media-urlMedia link for a message
POST/chatrooms/{chatRoomId}/readClear unread count
GET/media-filesMedia library
GET/media-files/{messageId}/urlMedia link by storage id

Health & configuration4 routes

GET/health/liveLiveness
GET/health/readyReadiness
GET/health/clientsPer-session state
GET/configRuntime configuration

Webhook events

The events we POST to your webhookUrl — envelope and every type.