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.
WhatsApp Flows API is one of 17 APIs that WhatsApp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Flows, Forms, Interactive, and Messaging. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, an API reference, a changelog, a GitHub repository, a getting-started guide, and 1 JSON Schema.
This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 21.0.
Requests are made against a single base URL, https://graph.facebook.com/v21.0.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
WhatsApp Flows API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— System User Token with whatsappbusinessmanagement permission
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Create, read, update, and delete flows
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Flow (10 properties), FlowValidationError (8 properties), CreateFlowRequest (4 properties), UpdateFlowRequest (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WhatsApp 12
Other APIs WhatsApp publishes across the network.