Qodex.ai

#WhatsApp Flows API

Number of APIs: 18

Welcome to the WhatsApp Flows API from Meta. This collection contains the Graph API requests to create, manage, and send WhatsApp Flows. For the full Flows documentation, refer to https://developers.facebook.com/docs/whatsapp/flows

Note: Flow messages won't be delivered to unsupported WhatsApp versions.

Installation

Import this collection into Qodex to start using the API.

You can generate the code for the API calls in your language by following the steps here [

Environment

This collection uses environment variables. To edit the variables in the collection

  1. Click on the environment name in the left sidebar
  2. Go to the Variables tab
  3. Update the Current Value for the variables

Here's the list of the variables used in the collection

Name Description
base-url Base URL for Facebook Graph API. Example: https://graph.facebook.com/v18.0
access-token This can be retrieved by copying the Temporary access token from your app which expires in 24 hours.

Alternatively, you can generate a System User Access Token .
waba-id Your WhatsApp Business Account (WABA) ID.
flow-id Id of the flow to update or send. You can set this variable after creating a flow.
business-phone-number-id ID for the sender phone number connected to the WhatsApp Business API. You can get this from the request Get WABA Phone Numbers .
customer-phone-number Phone number that you want to send a flow to.

General Notes

  • You can add `fields` param to any request to specify which exact fields will be returned in the response
  • POST requests accept the data in query or form or JSON body. However, the asset upload API only accepts the file attachment in form data

Changelog

Updates to the Flows API will be tracked here

  1. 1. Create Flow - Get Flow GET {{base-url}}/{{flow-id}}?fields=id,name,categories,preview,status,validation_errors,json_version,data_api_version,data_channel_uri,whatsapp_business_account,application

  2. 1. Create Flow - List Flows GET {{base-url}}/{{waba-id}}/flows

  3. 1. Create Flow - Create Flow POST {{base-url}}/{{waba-id}}/flows

  4. 2. Update Flow - Upload Flow JSON Asset POST {{base-url}}/{{flow-id}}/assets

  5. 2. Update Flow - Get Preview URL GET {{base-url}}/{{flow-id}}?fields=preview.invalidate(false)

  6. 2. Update Flow - Publish Flow POST {{base-url}}/{{flow-id}}/publish

  7. 2. Update Flow - Update Flow Metadata POST {{base-url}}/{{flow-id}}

  8. 2. Update Flow - Deprecate Flow POST {{base-url}}/{{flow-id}}/deprecate

  9. 2. Update Flow - Delete Flow DELETE {{base-url}}/{{flow-id}}

  10. 3. Setup Encryption - Set Encryption Public Key POST {{base-url}}/{{business-phone-number-id}}/whatsapp_business_encryption