WhatsApp — API Provider, Schemas

APIs for the WhatsApp messaging platform, enabling businesses to communicate with customers through the world's most popular messaging app.

4 APIs 10 Features

APIs

WhatsApp Business Platform API

The Cloud API and On-Premises API that enables medium and large businesses to communicate with customers at scale.

WhatsApp Business Account Management API

API for managing WhatsApp Business Accounts, phone numbers, and messaging templates.

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...

Collections

WhatsApp Business Management API

POSTMAN

WhatsApp Cloud API

POSTMAN

WhatsApp Flows API

POSTMAN

WhatsApp Business Management API

OPEN

WhatsApp Cloud API

OPEN

WhatsApp Flows API

OPEN

Arazzo Workflows

WhatsApp Create and Retrieve QR Code

Create a click-to-chat QR code and read back its deep link and image URLs.

ARAZZO

WhatsApp Create Template then Send

Create a new message template and send it once it is available.

ARAZZO

WhatsApp Build, Publish, and Send a Flow

Create a flow, upload its JSON, publish it, and send it as an interactive flow message.

ARAZZO

WhatsApp Verify and Register Phone Number

Request a verification code, verify it, then register the phone number.

ARAZZO

WhatsApp Send Message then React to It

Send a text message and then apply an emoji reaction to that same message.

ARAZZO

WhatsApp Check Number then Send Interactive Buttons

Confirm the sending number is verified, then send an interactive reply-button message.

ARAZZO

WhatsApp Confirm Profile then Send Location

Read the business profile to confirm the sender, then send a location pin.

ARAZZO

WhatsApp Find Approved Template and Send

Look up an approved message template by name and send it to a recipient.

ARAZZO

WhatsApp Send Text and Mark Inbound Read

Send a text reply and mark the customer's inbound message as read.

ARAZZO

WhatsApp Subscribe App to WABA Webhooks

Confirm the WABA is active, subscribe the app to webhooks, then list subscriptions.

ARAZZO

WhatsApp Read and Update Business Profile

Read the current business profile, then apply updates to it.

ARAZZO

WhatsApp Find and Update Message Template

Locate a template by name and edit its body, when it is in an editable state.

ARAZZO

WhatsApp Upload and Send Document

Upload a document file and send it to a recipient with a display filename.

ARAZZO

WhatsApp Upload Media and Send Image Message

Upload an image to WhatsApp servers and send it to a recipient by media ID.

ARAZZO

Pricing Plans

Whatsapp Plans Pricing

2 plans

PLANS

Rate Limits

Whatsapp Rate Limits

6 limits

RATE LIMITS

FinOps

Whatsapp Finops

FINOPS

Features

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.

Use Cases

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.

Integrations

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

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.

Event Specifications

WhatsApp Webhooks

WhatsApp Business Platform webhooks deliver real-time notifications for incoming messages, message status updates, template status changes, account updates, phone number quality...

ASYNCAPI

Semantic Vocabularies

Whatsapp Context

33 classes · 109 properties

JSON-LD

API Governance Rules

WhatsApp API Rules

17 rules · 14 errors 2 warnings 1 info

SPECTRAL

JSON Structure

Whatsapp Business Management Api Conversation Analytics Structure

1 properties

JSON STRUCTURE

Whatsapp Business Management Api Create Template Request Structure

5 properties

JSON STRUCTURE

Whatsapp Business Management Api Cursor Paging Structure

3 properties

JSON STRUCTURE

Whatsapp Business Management Api Message Template Structure

8 properties

JSON STRUCTURE

Whatsapp Business Management Api Phone Number Structure

11 properties

JSON STRUCTURE

Whatsapp Business Management Api Success Response Structure

1 properties

JSON STRUCTURE

Whatsapp Business Management Api Template Analytics Structure

1 properties

JSON STRUCTURE

Whatsapp Business Management Api Template Button Structure

8 properties

JSON STRUCTURE

Whatsapp Business Management Api Template Component Definition Structure

7 properties

JSON STRUCTURE

Whatsapp Business Management Api Whats App Business Account Structure

11 properties

JSON STRUCTURE

Whatsapp Cloud Api Audio Object Structure

2 properties

JSON STRUCTURE

Whatsapp Cloud Api Contact Object Structure

7 properties

JSON STRUCTURE

Whatsapp Cloud Api Document Object Structure

4 properties

JSON STRUCTURE

Whatsapp Cloud Api Interactive Message Structure

5 properties

JSON STRUCTURE

Whatsapp Cloud Api List Section Structure

2 properties

JSON STRUCTURE

Whatsapp Cloud Api Location Message Structure

4 properties

JSON STRUCTURE

Whatsapp Cloud Api Media Object Structure

3 properties

JSON STRUCTURE

Whatsapp Cloud Api Reaction Message Structure

2 properties

JSON STRUCTURE

Whatsapp Cloud Api Send Message Request Structure

19 properties

JSON STRUCTURE

Whatsapp Cloud Api Send Message Response Structure

3 properties

JSON STRUCTURE

Whatsapp Cloud Api Sticker Object Structure

2 properties

JSON STRUCTURE

Whatsapp Cloud Api Template Component Structure

4 properties

JSON STRUCTURE

Whatsapp Cloud Api Template Message Structure

3 properties

JSON STRUCTURE

Whatsapp Cloud Api Template Parameter Structure

10 properties

JSON STRUCTURE

Whatsapp Cloud Api Text Message Structure

2 properties

JSON STRUCTURE

Whatsapp Flow Json Structure

4 properties

JSON STRUCTURE

Whatsapp Flows Api Create Flow Request Structure

4 properties

JSON STRUCTURE

Whatsapp Flows Api Cursor Paging Structure

2 properties

JSON STRUCTURE

Whatsapp Flows Api Flow Structure

10 properties

JSON STRUCTURE

Whatsapp Flows Api Flow Validation Error Structure

8 properties

JSON STRUCTURE

Whatsapp Flows Api Success Response Structure

1 properties

JSON STRUCTURE

Whatsapp Flows Api Update Flow Request Structure

4 properties

JSON STRUCTURE

Whatsapp Message Structure

17 properties

JSON STRUCTURE

Whatsapp Message Template Structure

5 properties

JSON STRUCTURE

Whatsapp Webhook Payload Structure

2 properties

JSON STRUCTURE

Example Payloads

Whatsapp Business Management Api Conversation Analytics Example

1 fields

EXAMPLE

Whatsapp Business Management Api Create Template Request Example

5 fields

EXAMPLE

Whatsapp Business Management Api Cursor Paging Example

3 fields

EXAMPLE

Whatsapp Business Management Api Message Template Example

8 fields

EXAMPLE

Whatsapp Business Management Api Phone Number Example

10 fields

EXAMPLE

Whatsapp Business Management Api Success Response Example

1 fields

EXAMPLE

Whatsapp Business Management Api Template Analytics Example

1 fields

EXAMPLE

Whatsapp Business Management Api Template Button Example

8 fields

EXAMPLE

Whatsapp Business Management Api Template Component Definition Example

7 fields

EXAMPLE

Whatsapp Business Management Api Whats App Business Account Example

10 fields

EXAMPLE

Whatsapp Cloud Api Audio Object Example

2 fields

EXAMPLE

Whatsapp Cloud Api Contact Object Example

7 fields

EXAMPLE

Whatsapp Cloud Api Document Object Example

4 fields

EXAMPLE

Whatsapp Cloud Api Interactive Message Example

5 fields

EXAMPLE

Whatsapp Cloud Api List Section Example

2 fields

EXAMPLE

Whatsapp Cloud Api Location Message Example

4 fields

EXAMPLE

Whatsapp Cloud Api Media Object Example

3 fields

EXAMPLE

Whatsapp Cloud Api Reaction Message Example

2 fields

EXAMPLE

Whatsapp Cloud Api Send Message Request Example

10 fields

EXAMPLE

Whatsapp Cloud Api Send Message Response Example

3 fields

EXAMPLE

Whatsapp Cloud Api Sticker Object Example

2 fields

EXAMPLE

Whatsapp Cloud Api Template Component Example

4 fields

EXAMPLE

Whatsapp Cloud Api Template Message Example

3 fields

EXAMPLE

Whatsapp Cloud Api Template Parameter Example

10 fields

EXAMPLE

Whatsapp Cloud Api Text Message Example

2 fields

EXAMPLE

Whatsapp Flow Json Example

4 fields

EXAMPLE

Whatsapp Flows Api Create Flow Request Example

4 fields

EXAMPLE

Whatsapp Flows Api Cursor Paging Example

2 fields

EXAMPLE

Whatsapp Flows Api Flow Example

10 fields

EXAMPLE

Whatsapp Flows Api Flow Validation Error Example

8 fields

EXAMPLE

Whatsapp Flows Api Success Response Example

1 fields

EXAMPLE

Whatsapp Flows Api Update Flow Request Example

4 fields

EXAMPLE

Whatsapp Message Example

10 fields

EXAMPLE

Whatsapp Message Template Example

5 fields

EXAMPLE

Whatsapp Webhook Payload Example

2 fields

EXAMPLE

Resources

GitHubOrganization

PostmanCollection

Business Messaging Policy

Business Messaging Policy

Sources

opencollection: 1.0.0
info:
  name: WhatsApp Flows API
  version: '21.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Flows
    type: folder
  items:
  - info:
      name: WhatsApp List Flows
      type: http
    http:
      method: GET
      url: https://graph.facebook.com/v21.0/:waba-id/flows
      params:
      - name: waba-id
        value: ''
        type: path
        description: WhatsApp Business Account ID
      - name: fields
        value: example_value
        type: query
        description: Comma-separated fields to return
    docs: Lists all flows for a WhatsApp Business Account.
  - info:
      name: WhatsApp Create Flow
      type: http
    http:
      method: POST
      url: https://graph.facebook.com/v21.0/:waba-id/flows
      params:
      - name: waba-id
        value: ''
        type: path
        description: WhatsApp Business Account ID
      body:
        type: json
        data: '{}'
    docs: Creates a new flow for a WhatsApp Business Account.
  - info:
      name: WhatsApp Get Flow
      type: http
    http:
      method: GET
      url: https://graph.facebook.com/v21.0/:flow-id
      params:
      - name: flow-id
        value: ''
        type: path
        description: Flow ID
      - name: fields
        value: example_value
        type: query
        description: Comma-separated fields to return
    docs: Retrieves details about a specific flow.
  - info:
      name: WhatsApp Update Flow
      type: http
    http:
      method: POST
      url: https://graph.facebook.com/v21.0/:flow-id
      params:
      - name: flow-id
        value: ''
        type: path
        description: Flow ID
      body:
        type: json
        data: '{}'
    docs: Updates a flow. Only DRAFT flows can be updated. Published flows cannot be modified; clone them instead.
  - info:
      name: WhatsApp Delete Flow
      type: http
    http:
      method: DELETE
      url: https://graph.facebook.com/v21.0/:flow-id
      params:
      - name: flow-id
        value: ''
        type: path
        description: Flow ID
    docs: Deletes a flow. Only DRAFT flows can be deleted. Published flows must be deprecated instead.
- info:
    name: Assets
    type: folder
  items:
  - info:
      name: WhatsApp Get Flow Assets
      type: http
    http:
      method: GET
      url: https://graph.facebook.com/v21.0/:flow-id/assets
      params:
      - name: flow-id
        value: ''
        type: path
        description: Flow ID
    docs: Retrieves the assets (flow JSON file) for a flow.
  - info:
      name: WhatsApp Upload Flow JSON
      type: http
    http:
      method: POST
      url: https://graph.facebook.com/v21.0/:flow-id/assets
      params:
      - name: flow-id
        value: ''
        type: path
        description: Flow ID
      body:
        type: multipart-form
        data:
        - name: file
          type: text
          value: ''
        - name: name
          type: text
          value: ''
        - name: asset_type
          type: text
          value: ''
    docs: Uploads or replaces the flow JSON definition file. The file is validated on upload and any errors are returned in
      the response.
- info:
    name: Lifecycle
    type: folder
  items:
  - info:
      name: WhatsApp Publish Flow
      type: http
    http:
      method: POST
      url: https://graph.facebook.com/v21.0/:flow-id/publish
      params:
      - name: flow-id
        value: ''
        type: path
        description: Flow ID
    docs: Publishes a draft flow, making it available for use in messages. The flow must have a valid uploaded flow JSON with
      no validation errors.
  - info:
      name: WhatsApp Deprecate Flow
      type: http
    http:
      method: POST
      url: https://graph.facebook.com/v21.0/:flow-id/deprecate
      params:
      - name: flow-id
        value: ''
        type: path
        description: Flow ID
    docs: Deprecates a published flow. Deprecated flows remain visible in history but cannot be sent to customers.
bundled: true