Log inTry for free
Back to all APIs

Add WhatsApp Flow JSON

Add WhatsApp Flow JSON. File created from provided JSON content is sent and validated, errors found are provided in response. Regardless of whether any validation errors are returned, the Flow JSON is loaded on the Meta side and the request is considered successful. The maximum size of created file is 10MB. More information about JSON structure can be found under Meta documentation: https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson.

Learn more about WhatsApp channel and use cases.
Please log in to see full path URL. Learn why.
put
/whatsapp/1/senders/{sender}/flows/{flowId}/json
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
whatsapp:manage
Request rate limit:
100 requests / hour (per account)
path Parameters
sender
required
string
Example: 447796344125

Registered WhatsApp sender number. Must be in international format.

flowId
required
string
Example: 123456

ID of the flow to attach JSON to.

Request Body schema:
application/json
collapse all -
string

Flow JSON file content. The size is limited to 10 MB.

Responses

201

Flow JSON Added

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Request samples

Content type
application/json
Copy
 Collapse all
{
  • "version": "2.1",
  • "data_api_version": "3.0",
  • "routing_model":
    {
    • "MY_FIRST_SCREEN": [ ]
    },
  • "screens":
    {
    • "id": "MY_FIRST_SCREEN",
    • "title": "MY_FIRST_SCREEN",
    • "terminal": true,
    • "data":
      {
      • "hello_world_text":
        {
        • "type": "string",
        • "__example__": "Hello World"
        }
      },
    • "layout":
      {
      • "type": "SingleColumnLayout",
      • "children":
        [
        • {
          • "type": "TextHeading",
          • "text": "${data.hello_world_text}"
          },
        • {
          • "type": "Footer",
          • "label": "Static footer label",
          • "on-click-action":
            {
            • "name": "data_exchange",
            • "payload": { }
            }
          }
        ]
      }
    }
}

Response samples

Content type
application/json
Example
Validation errors
Copy
 Collapse all
{
  • "validationErrors":
    [
    • {
      • "error": "INVALID_PROPERTY",
      • "errorType": "JSON_SCHEMA_ERROR",
      • "message": "The property \"initial-text\" cannot be specified at \"$root/screens/0/layout/children/2/children/0\".",
      • "lineStart": 46,
      • "lineEnd": 46,
      • "columnStart": 17,
      • "columnEnd": 30
      }
    ]
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use