Create WhatsApp Flow

Create a WhatsApp flow. If successful, flow will be created in DRAFT status with default flow.json. Flow.json contains structure of the flow and other fields given in request can be updated until publication.

Learn more about WhatsApp channel and use cases.

Please log in to see full path URL. Learn why.

post

/whatsapp/1/senders/{sender}/flows

Authorizations:

Scopes:

whatsapp:manage

Request rate limit:

100 requests / hour (per account)

Learn more

path Parameters

sender

required

string

Example: 447796344125

Registered WhatsApp sender number. Must be in international format.

Request Body schema:

application/json

collapse all -

name required	string [ 1 .. 200 ] characters Name of the flow.
categories required	Array of strings Items Enum: "SIGN_UP" "SIGN_IN" "APPOINTMENT_BOOKING" "LEAD_GENERATION" "CONTACT_US" "CUSTOMER_SUPPORT" "SURVEY" "OTHER" "SHOPPING" "UNKNOWN" Categories of the flow.
cloneFlowId	string ID of source Flow to clone. The new flow with DRAFT status will inherit the flow.json from source flow.

Responses

201

Flow Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Request samples

Content type

application/json

Example

Copy

Collapse all


{"name": "My flow",
"categories": 
["SURVEY"
]
}

Response samples

Content type

application/json

Copy

Collapse all


{"id": "123456",
"name": "My flow",
"businessAccountId": 987654,
"categories": 
["SURVEY"
],
"status": "DRAFT"
}

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

Privacy documents Terms of use