Skip to main content

Wati APIs overview

Summary

Wati provides Application Programming Interfaces (APIs) that let you connect Wati with your existing systems, automate messaging, manage contacts, run campaigns, and access other Wati features programmatically.

This guide provides an overview of the available Wati APIs, including their endpoints, supported API versions, and links to additional developer resources.

Important: v3 is recommended for all new integrations. Legacy v1 and v2 endpoints remain available where supported.

Instructions

1. Understand Wati API Versions and Endpoints

Wati API endpoints use different URL formats depending on the API version.

Base URL: https://live-mt-server.wati.io

API version

URL path format

Tenant ID required in path?

v3

/api/ext/v3/...

No

v1

/{tenantId}/api/v1/...

Yes

v2

/{tenantId}/api/v2/...

Yes

For v1 and v2 endpoints, replace {tenantId} with your Wati tenant ID. For v3 endpoints, the tenant ID is not included in the URL path.

Use v3 for new integrations wherever the required operation is supported. Use legacy endpoints when the required operation is not available in v3.

2. Create an API Token

You need an API token to authenticate requests to Wati API endpoints.

To create an API token:

  • Log in to your Wati account.

  • Go to Connector > API.

  • Select Create API Token.

  • Create a token with the appropriate permissions for the API operations you want to perform.

For v3 endpoints, select the required token scope:

Token scope

Used for

contactsv3:*

Contact operations

conversationsv3:*

Conversation operations

messagetemplatev3:write

Sending message templates

Make sure your token has the required scope for the endpoint you want to use.

3. Explore Available Wati APIs

The following sections group Wati APIs by functionality. Each table lists the available operations and their documented endpoint paths.

3.1 Channels API

Use the Channels API to retrieve information about your connected WhatsApp numbers.

Operation

Method

v3 endpoint

v1 endpoint

List connected WhatsApp numbers

GET

/api/ext/v3/channels

/{tenantId}/api/v1/whatsApp/phoneNumbers

3.2 Messaging API

Use the Messaging API to send messages, retrieve conversation message history, and manage conversations.

Operation

Method

v3 endpoint

v1 endpoint

Get message history for a contact

GET

/api/ext/v3/conversations/{target}/messages

/{tenantId}/api/v1/getMessages/{target}

Send a session text message

—

v3 available

/{tenantId}/api/v1/sendSessionMessage/{whatsappNumber}

Send a session file

—

v3 available

/{tenantId}/api/v1/sendSessionFile/{whatsappNumber}

Send a session file via URL

—

v3 available

/{tenantId}/api/v1/sendSessionFileViaUrl/{whatsappNumber}

Send a template message

—

v3 available

/{tenantId}/api/v1/sendTemplateMessage

Send template messages in bulk

—

v3 available

/{tenantId}/api/v1/sendTemplateMessages

Send template messages using a CSV file

POST

—

/{tenantId}/api/v1/sendTemplateMessageCSV

Send an interactive button message

—

v3 available

/{tenantId}/api/v1/sendInteractiveButtonsMessage/{whatsappNumber}

Send an interactive list message

—

v3 available

/{tenantId}/api/v1/sendInteractiveListMessage/{whatsappNumber}

Send an interactive call-to-action (CTA) URL message

POST

—

/{tenantId}/api/v1/sendInteractiveCtaUrlMessage

Update conversation status

PUT

/api/ext/v3/conversations/{target}/status

/{tenantId}/api/v1/updateChatStatus

Assign an operator to a conversation

PUT

/api/ext/v3/conversations/{target}/operator

/{tenantId}/api/v1/assignOperator

Important notes:

  • The Get Message History API retrieves the conversation history for a specific contact. It does not retrieve all messages received by your WhatsApp number.

  • A successful HTTP 200 response from a message-sending API means the request was accepted. It does not confirm that the message was delivered to the recipient.

  • Use the sentMessageDELIVERED_v2 webhook event to track message delivery. The templateMessageFailed event reports message-sending failures.

3.3 Contacts API

Use the Contacts API to create, retrieve, update, delete, and organize contacts in Wati.

Operation

Method

v3 endpoint

v1 endpoint

List contacts

GET

/api/ext/v3/contacts

/{tenantId}/api/v1/getContacts

Add a contact

POST

/api/ext/v3/contacts

/{tenantId}/api/v1/addContact/{whatsappNumber}

Update contact attributes

PUT

/api/ext/v3/contacts

/{tenantId}/api/v1/updateContactAttributes/{whatsappNumber}

Update multiple contacts

POST

—

/{tenantId}/api/v1/updateContactAttributesForMultiContacts

Get contact details

GET

/api/ext/v3/contacts/{target}

—

Get the total contact count

GET

/api/ext/v3/contacts/count

—

Delete a contact

—

v3 available

—

Assign contacts to teams

PUT

/api/ext/v3/contacts/teams

—

Plan requirement: Updating multiple contacts through the v1 endpoint requires a Business plan.

3.4 Message Templates API

Use the Message Templates API to retrieve, create, and delete WhatsApp message templates.

Operation

Method

v3 endpoint

v1 endpoint

List message templates

GET

/api/ext/v3/messageTemplates

/{tenantId}/api/v1/getMessageTemplates

Get a template by ID

GET

/api/ext/v3/messageTemplates/{template_id}

—

Create a template

POST

—

/{tenantId}/api/v1/whatsApp/templates

Delete a template

DELETE

—

/{tenantId}/api/v1/whatsApp/templates/{wabaId}/{name}/{language}

3.5 Campaigns API

Use the Campaigns API to retrieve campaign information, estimate campaign costs, and manage scheduled broadcasts.

Operation

Method

v3 endpoint

v1 endpoint

List campaigns

GET

/api/ext/v3/broadcasts

—

Get campaign details

GET

/api/ext/v3/broadcasts/{broadcast_id}

—

Get campaign recipients

GET

/api/ext/v3/broadcasts/{broadcast_id}/recipients

—

Get campaign overview

GET

/api/ext/v3/broadcasts/overview

—

Estimate campaign cost

POST

/api/ext/v3/broadcasts/estimate-cost

—

Schedule a campaign

POST

—

/{tenantId}/api/v1/broadcast/scheduleBroadcast

Delete a scheduled campaign

DELETE

—

/{tenantId}/api/v1/broadcast/deleteScheduledBroadcast/{broadcastId}

3.6 Tags API

Use the Tags API to organize conversations by adding or removing tags.

Operation

v3 availability

Add a tag to a conversation

Available

Remove a tag from a conversation

Available

Refer to the Wati API documentation for the relevant endpoint paths and request details.

3.7 Typing Indicator API

Use the Typing Indicator API to display a typing indicator to a contact during an active messaging session.

Operation

v3 availability

Send a typing indicator

Available

Refer to the Wati API documentation for endpoint details.

3.8 Calls API

Use the Calls API to retrieve call logs, recordings, transcripts, and summaries.

Operation

Method

v3 endpoint

Get call logs

GET

/api/ext/v3/calls

Get a call recording

GET

/api/ext/v3/calls/{call_id}/recording

Get a call transcript

GET

/api/ext/v3/calls/{call_id}/transcript

Get a call summary

GET

/api/ext/v3/calls/{call_id}/summary

Retrieve multiple recordings, transcripts, or summaries

—

v3 available

Refer to the Wati API documentation for the request details for batch operations.

3.9 Chatbots API

Use the Chatbots API to retrieve available chatbots and start chatbot flows.

Operation

Method

v3 endpoint

v1 endpoint

List chatbots

GET

/api/ext/v3/chatbots

/{tenantId}/api/v1/chatbots

Start a chatbot

POST

/api/ext/v3/chatbots/start

/{tenantId}/api/v1/chatbots/start

Plan requirement: The Chatbots API requires a Pro or Business plan.

3.10 Segments API

Use the Segments API to retrieve contact segments, evaluate segment filters, and create custom segments.

Operation

Method

v3 endpoint

v1 endpoint

List segments

GET

/api/ext/v3/segments

—

Get a segment

GET

/api/ext/v3/segments/{segmentId}

—

Evaluate segment filters

—

v3 available

—

Create a custom segment

POST

—

/{tenantId}/api/v1/createCustomSegment

Plan requirement: Creating a custom segment through the v1 endpoint requires a Pro or Business plan.

3.11 Webhook Management API

Webhooks allow Wati to send event notifications to a URL you configure. You can use the Webhook Management API to manage webhook subscriptions programmatically.

Operation

Method

v3 endpoint

v2 endpoint

List webhook subscriptions

GET

/api/ext/v3/webhooks

—

Get a webhook subscription

GET

/api/ext/v3/webhooks/{id}

—

Update a webhook subscription

PUT

/api/ext/v3/webhooks/{id}

—

Delete a webhook subscription

DELETE

/api/ext/v3/webhooks/{id}

—

List available webhook event types

—

v3 available

—

Create a webhook subscription

POST

—

/{tenantId}/api/v2/webhookEndpoints

For instructions on configuring and handling webhook events, see the Wati Webhooks Documentation.

3.12 Instagram API

Use the Instagram API to retrieve Instagram posts and comments and reply to comments.

Operation

Method

v3 endpoint

List Instagram posts

GET

/api/ext/v3/posts

Get an Instagram post

GET

/api/ext/v3/posts/{post_id}

List comments on a post

GET

/api/ext/v3/posts/{post_id}/comments

Get the unread comment count

GET

/api/ext/v3/posts/{post_id}/unreadCount

Reply to a comment

POST

/api/ext/v3/comments/{comment_id}/replies

Send a private reply to a comment

POST

/api/ext/v3/comments/{comment_id}/privateReply

3.13 Account Credits API

Use the Account Credits API to check the credit balance of your Wati account.

Operation

Method

v3 endpoint

Get account credits

GET

/api/ext/v3/account/credits

3.14 Media and Token Management APIs

Use the Media APIs to retrieve media files and the token management API to block an API token.

Operation

Method

v3 endpoint

v1 endpoint

Get media by file name

GET

—

/{tenantId}/api/v1/getMedia

Get media by message ID

GET

/api/ext/v3/conversations/messages/file/{message_id}

—

Block a token

POST

—

/{tenantId}/api/v1/rotateToken

Important: The v1 rotateToken endpoint blocks the specified token. It does not generate a replacement token. To create a new API token, go to Connector > API > Create API Token in your Wati account.

3.15 Model Context Protocol (MCP) Server

Wati provides a Model Context Protocol (MCP) server that allows AI tools and agents to connect directly to Wati capabilities.

For setup instructions, see the Wati developer documentation.

4. Additional Resources

Use the following resources to explore API endpoints, configure webhooks, and test API requests.

5. Important API Notes

Keep the following points in mind when integrating with Wati:

  • Choose the right API version: Use v3 for new integrations wherever the required operation is supported. Legacy v1 and v2 endpoints remain available where documented.

  • Use the correct URL format: v3 endpoints do not include the tenant ID in the path. The documented v1 and v2 endpoints include /{tenantId}/.

  • Use the correct token scope: Create an API token with the permissions required for your v3 operations.

  • Check message delivery separately: A successful HTTP 200 response from a message-sending endpoint does not confirm delivery. Use the relevant webhook event to track delivery or failure.

  • Understand token rotation: The v1 rotateToken endpoint blocks a token rather than creating a new one.

For endpoint-specific parameters, request formats, responses, and examples, refer to the Wati API documentation.

Did this answer your question?