APIs for the WhatsApp messaging platform, enabling businesses to communicate with customers through the world's most popular messaging app.
WhatsApp publishes 17 APIs on the APIs.io network, including Flows API, On-Premises API, Analytics API, and 14 more.
The WhatsApp catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 3 Spectral governance rulesets.
WhatsApp’s developer surface includes authentication, getting-started guide, changelog, engineering blog, support, developer console, Stack Overflow tag, and 40 more developer resources.
Kin Score
APIs 17
Individual APIs this provider publishes, each with its own machine-readable definition.
WhatsApp Flows API
API for creating structured, interactive forms and multi-step flows within WhatsApp conversations, enabling appointment booking, surveys, lead capture, and other guided experien...
WhatsApp On-Premises API
The self-hosted version of the WhatsApp Business API that allowed businesses to run the API on their own infrastructure. This API was deprecated on October 23, 2025, and all use...
WhatsApp Analytics API
Retrieve conversation and template analytics
WhatsApp Assets API
Upload and retrieve flow JSON assets
WhatsApp Assigned Users API
Manage user access to a WABA
WhatsApp Business Accounts API
Manage WhatsApp Business Account information
WhatsApp Business Profile API
Get and update WhatsApp Business profile information
WhatsApp Lifecycle API
Publish and deprecate flows
WhatsApp Media API
Upload, retrieve, and delete media files
WhatsApp Message Templates API
Create, update, and delete message templates
WhatsApp Messages API
Send messages of all types to WhatsApp users
WhatsApp Phone Numbers API
List and manage phone numbers on a WABA
WhatsApp Product Catalogs API
Connect and manage product catalogs
WhatsApp QR Codes API
Create and manage QR codes for customer conversations
WhatsApp Registration API
Register and deregister phone numbers
WhatsApp Subscribed Apps API
Manage webhook subscriptions for a WABA
WhatsApp Two-Step Verification API
Manage two-step verification PIN
Scroll for all 17
Postman Collections 3
Ready-to-run Postman collections for exercising this provider's APIs.
Open Collections 3
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
WhatsApp Business Management API
OPEN COLLECTIONWhatsApp Cloud API
OPEN COLLECTIONWhatsApp Flows API
OPEN COLLECTIONArazzo Workflows 14
Multi-step API workflows described with the Arazzo specification.
WhatsApp Create and Retrieve QR Code
Create a click-to-chat QR code and read back its deep link and image URLs.
ARAZZOWhatsApp Create Template then Send
Create a new message template and send it once it is available.
ARAZZOWhatsApp Build, Publish, and Send a Flow
Create a flow, upload its JSON, publish it, and send it as an interactive flow message.
ARAZZOWhatsApp Verify and Register Phone Number
Request a verification code, verify it, then register the phone number.
ARAZZOWhatsApp Send Message then React to It
Send a text message and then apply an emoji reaction to that same message.
ARAZZOWhatsApp Check Number then Send Interactive Buttons
Confirm the sending number is verified, then send an interactive reply-button message.
ARAZZOWhatsApp Confirm Profile then Send Location
Read the business profile to confirm the sender, then send a location pin.
ARAZZOWhatsApp Find Approved Template and Send
Look up an approved message template by name and send it to a recipient.
ARAZZOWhatsApp Send Text and Mark Inbound Read
Send a text reply and mark the customer's inbound message as read.
ARAZZOWhatsApp Subscribe App to WABA Webhooks
Confirm the WABA is active, subscribe the app to webhooks, then list subscriptions.
ARAZZOWhatsApp Read and Update Business Profile
Read the current business profile, then apply updates to it.
ARAZZOWhatsApp Find and Update Message Template
Locate a template by name and edit its body, when it is in an editable state.
ARAZZOWhatsApp Upload and Send Document
Upload a document file and send it to a recipient with a display filename.
ARAZZOWhatsApp Upload Media and Send Image Message
Upload an image to WhatsApp servers and send it to a recipient by media ID.
ARAZZOScroll for all 14
Pricing Plans 1
Published pricing tiers and plan structures.
Rate Limits 1
Documented rate limits and quota policies.
Whatsapp Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals for API financial operations.
Whatsapp Finops
FINOPSFeatures 10
Notable capabilities this provider offers.
Cloud API
Send and receive messages, media, and interactive content through Meta-hosted WhatsApp infrastructure.
Message Templates
Pre-approved message templates for proactive customer communication with variable substitution.
Interactive Messages
Buttons, lists, product catalogs, and flows for rich customer engagement.
Media Messaging
Send and receive images, videos, documents, audio, stickers, and location data.
Webhooks
Real-time notifications for incoming messages, delivery status, and account events.
Business Management API
Manage WhatsApp Business accounts, phone numbers, and messaging limits.
Flows
Build interactive multi-step forms and workflows within WhatsApp conversations.
Catalogs and Commerce
Share product catalogs and enable in-chat commerce experiences.
Encryption
End-to-end encryption for all messages and media.
Multi-Agent Support
Route conversations to multiple agents with conversation assignment.
Scroll for all 10
Event Specifications 1
AsyncAPI definitions for this provider's event-driven and streaming APIs.
WhatsApp Webhooks
WhatsApp Business Platform webhooks deliver real-time notifications for incoming messages, message status updates, template status changes, account updates, phone number quality...
ASYNCAPISemantic Vocabularies 1
JSON-LD contexts and semantic vocabularies used across these APIs.
Whatsapp Context
JSON-LDSpectral Rules 3
Spectral governance rulesets for linting and validating these APIs.
JSON Schema 35
Standalone JSON Schema definitions for this provider's data models.
ConversationAnalytics
JSON SCHEMACreateTemplateRequest
JSON SCHEMACursorPaging
JSON SCHEMAMessageTemplate
JSON SCHEMAPhoneNumber
JSON SCHEMASuccessResponse
JSON SCHEMATemplateAnalytics
JSON SCHEMATemplateButton
JSON SCHEMATemplateComponentDefinition
JSON SCHEMAWhatsAppBusinessAccount
JSON SCHEMAAudioObject
JSON SCHEMAContactObject
JSON SCHEMADocumentObject
JSON SCHEMAInteractiveMessage
JSON SCHEMAListSection
JSON SCHEMALocationMessage
JSON SCHEMAMediaObject
JSON SCHEMAReactionMessage
JSON SCHEMASendMessageRequest
JSON SCHEMASendMessageResponse
JSON SCHEMAStickerObject
JSON SCHEMATemplateComponent
JSON SCHEMATemplateMessage
JSON SCHEMATemplateParameter
JSON SCHEMATextMessage
JSON SCHEMAWhatsApp Flow JSON
JSON SCHEMACreateFlowRequest
JSON SCHEMACursorPaging
JSON SCHEMAFlow
JSON SCHEMAFlowValidationError
JSON SCHEMASuccessResponse
JSON SCHEMAUpdateFlowRequest
JSON SCHEMAWhatsApp Message
JSON SCHEMAWhatsApp Message Template
JSON SCHEMAWhatsApp Webhook Payload
JSON SCHEMAScroll for all 35
JSON Structure 35
JSON Structure definitions describing this provider's data shapes.
Whatsapp Business Management Api Cursor Paging Structure
JSON STRUCTUREWhatsapp Business Management Api Phone Number Structure
JSON STRUCTUREWhatsapp Cloud Api Audio Object Structure
JSON STRUCTUREWhatsapp Cloud Api Contact Object Structure
JSON STRUCTUREWhatsapp Cloud Api Document Object Structure
JSON STRUCTUREWhatsapp Cloud Api Interactive Message Structure
JSON STRUCTUREWhatsapp Cloud Api List Section Structure
JSON STRUCTUREWhatsapp Cloud Api Location Message Structure
JSON STRUCTUREWhatsapp Cloud Api Media Object Structure
JSON STRUCTUREWhatsapp Cloud Api Reaction Message Structure
JSON STRUCTUREWhatsapp Cloud Api Send Message Request Structure
JSON STRUCTUREWhatsapp Cloud Api Send Message Response Structure
JSON STRUCTUREWhatsapp Cloud Api Sticker Object Structure
JSON STRUCTUREWhatsapp Cloud Api Template Component Structure
JSON STRUCTUREWhatsapp Cloud Api Template Message Structure
JSON STRUCTUREWhatsapp Cloud Api Template Parameter Structure
JSON STRUCTUREWhatsapp Cloud Api Text Message Structure
JSON STRUCTUREWhatsapp Flow Json Structure
JSON STRUCTUREWhatsapp Flows Api Create Flow Request Structure
JSON STRUCTUREWhatsapp Flows Api Cursor Paging Structure
JSON STRUCTUREWhatsapp Flows Api Flow Structure
JSON STRUCTUREWhatsapp Flows Api Flow Validation Error Structure
JSON STRUCTUREWhatsapp Flows Api Success Response Structure
JSON STRUCTUREWhatsapp Flows Api Update Flow Request Structure
JSON STRUCTUREWhatsapp Message Structure
JSON STRUCTUREWhatsapp Message Template Structure
JSON STRUCTUREWhatsapp Webhook Payload Structure
JSON STRUCTUREScroll for all 35
Examples 35
Example request and response payloads for these APIs.
Whatsapp Flow Json Example
EXAMPLEWhatsapp Message Example
EXAMPLEScroll for all 35
Security Posture 1
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
Recommended x-agentic-access execution contracts for AI agents.
Use Cases 8
What developers build with this provider.
Customer Support
Provide real-time customer service and support through WhatsApp messaging.
Order Notifications
Send order confirmations, shipping updates, and delivery notifications.
Appointment Reminders
Send appointment reminders and allow rescheduling via interactive messages.
Marketing Campaigns
Send promotional messages using approved templates to opted-in customers.
Two-Factor Authentication
Send OTP codes and verification messages for account security.
Chatbot Integration
Build automated conversational bots for FAQs and self-service workflows.
E-commerce
Share product catalogs, process orders, and send payment reminders.
Healthcare Communication
Send appointment reminders, test results, and health tips to patients.
Scroll for all 8
Integrations 5
Pre-built integrations with other platforms and tools.
Meta Business Suite
Manage WhatsApp alongside Facebook and Instagram from a unified dashboard.
Salesforce
CRM integration for managing customer conversations and contact history.
Shopify
E-commerce integration for order notifications and customer messaging.
HubSpot
Marketing and sales integration for lead nurturing via WhatsApp.
Zendesk
Help desk integration for ticketed WhatsApp customer support.
Solutions 3
Packaged solutions this provider offers.
WhatsApp Business Platform
Cloud API and On-Premises API for medium and large businesses at scale.
WhatsApp Business App
Free mobile app for small businesses with basic messaging features.
WhatsApp Flows
Interactive forms and workflows within WhatsApp conversations.
Resources
Get Started 4
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 17
Pagination, idempotency, versioning, errors, and events
Scroll for all 17
Build 5
SDKs, sample code, and the tooling you integrate with
Access & Security 3
Authentication, authorization, and security posture
Operate 7
Status, limits, changes, and where to get help
Scroll for all 7
Commercial 4
Pricing, plans, and the legal terms of use
Company 1
The organization behind the API
Other 3
Properties that don't map to a standard resource type