WhatsApp

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 experiences using a JSON-based screen definition format.

Documentation GitHub OpenAPI

Operations 17

GET /{Version}/{Phone-Number-ID}/whatsapp_business_encryption Get Business Encryption Public Key #

GET /{Version}/{WABA-ID}/flows List Flows #

POST /{Version}/{WABA-ID}/flows Create Flow #

POST /{Version}/{WABA-ID}/migrate_flows Migrate Flows #

GET /{Version}/{Flow-ID} Get Flow #

POST /{Version}/{Flow-ID} Update Flow Metadata #

DELETE /{Version}/{Flow-ID} Delete Flow #

GET /{Version}/{Flow-ID}/assets List Assets (Get Flow JSON URL) #

POST /{Version}/{Flow-ID}/assets Update Flow JSON #

POST /{Version}/{Flow-ID}/publish Publish Flow #

POST /{Version}/{Flow-ID}/deprecate Deprecate Flow #

POST /{Version}/{WABA-ID}/message_templates Create authentication template w/ OTP copy code button #

GET /{waba-id}/flows WhatsApp List Flows #

POST /{waba-id}/flows WhatsApp Create Flow #

GET /{flow-id} WhatsApp Get Flow #

POST /{flow-id} WhatsApp Update Flow #

DELETE /{flow-id} WhatsApp Delete Flow #

Documentation

https://developers.facebook.com/documentation/business-messaging/whatsapp/flows

https://developers.facebook.com/documentation/business-messaging/whatsapp/flows/gettingstarted

https://developers.facebook.com/documentation/business-messaging/whatsapp/get-started

Specifications

https://artifacts.apis.io/whatsapp/openapi/whatsapp-flows-api-openapi.yml

SDKs

GitHubRepository

https://github.com/WhatsApp/WhatsApp-Flows-Tools

Schemas & Data

https://artifacts.apis.io/whatsapp/json-schema/whatsapp-flow-json-schema.json

Other Resources

https://developers.facebook.com/documentation/business-messaging/whatsapp/flows/guides/components

https://developers.facebook.com/documentation/business-messaging/whatsapp/flows/changelogs

https://developers.facebook.com/documentation/business-messaging/whatsapp/flows/reference/error-codes

PostmanCollection

https://www.postman.com/meta/whatsapp-business-platform/collection/y5swede/whatsapp-flows-api

https://artifacts.apis.io/whatsapp/apis.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-create-qr-code-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-create-template-then-send-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-publish-flow-and-send-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-register-phone-number-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-send-and-react-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-send-interactive-buttons-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-send-location-message-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-send-template-message-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-send-text-and-mark-read-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-subscribe-webhooks-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-update-business-profile-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-update-template-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-upload-media-send-document-workflow.yml

https://artifacts.apis.io/whatsapp/arazzo/whatsapp-upload-media-send-image-workflow.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/whatsapp:flows-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Whatsapp Flows API
  version: '1.0'
  description: 'Operations tagged Flows across 2 of this provider''s published API definitions: whatsapp-business-messaging-api-v23.0-openapi.yaml, whatsapp-flows-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://graph.facebook.com
  description: Production Graph API server
- url: https://graph.facebook.com/v21.0
  description: Meta Graph API Production Server
tags:


# --- truncated at 32 KB (73 KB total) ---
# Full source: https://artifacts.apis.io/whatsapp/openapi/whatsapp-flows-api-openapi.yml