curl --request POST \
--url https://api.messaging.phonovation.com/whatsapp/1/senders/{sender}/flows \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My flow",
"categories": [
"SURVEY"
]
}
'{
"id": "123456",
"name": "My flow",
"businessAccountId": 987654,
"categories": [
"SURVEY"
],
"status": "DRAFT"
}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.
Required scope: Enable one of: whatsapp:manage.
curl --request POST \
--url https://api.messaging.phonovation.com/whatsapp/1/senders/{sender}/flows \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My flow",
"categories": [
"SURVEY"
]
}
'{
"id": "123456",
"name": "My flow",
"businessAccountId": 987654,
"categories": [
"SURVEY"
],
"status": "DRAFT"
}Authorizations
This is the most secure authorization type and the one with the most flexibility.
API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.
You can manage your API keys from GUI, or programmatically with dedicated API.
API key Authorization header example:
Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
Path Parameters
Registered WhatsApp sender number. Must be in international format.
1Body
Name of the flow.
1 - 200"My first flow"
Categories of the flow.
1Categories of the flow.
SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY, OTHER, SHOPPING, UNKNOWN "SIGN_UP"
ID of source Flow to clone. The new flow with DRAFT status will inherit the flow.json from source flow.
"987654"
Response
Flow Created
List of found flows.
ID of the flow.
"123456"
Name of the flow.
"My first flow"
WhatsApp business account ID.
987654
Categories of the flow.
Categories of the flow.
SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY, OTHER, SHOPPING, UNKNOWN "SIGN_UP"
Status of the flow.
DRAFT, PUBLISHED, DEPRECATED, BLOCKED, THROTTLED "DRAFT"
IDs of the initial screens required to send a flow with flowAction set to 'NAVIGATE'. Only exists for flows after publishing.
IDs of the initial screens required to send a flow with flowAction set to 'NAVIGATE'. Only exists for flows after publishing.