WhatsApp · WhatsApp Flows
Creates a flow.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
accountIdstringrequirednamestringrequiredUp to 128 characters.
categoriesarray of stringrequiredAt least 1 item. Each item: one of
SIGN_UP,SIGN_IN,APPOINTMENT_BOOKING,LEAD_GENERATION,CONTACT_US,CUSTOMER_SUPPORT,SURVEY,OTHER.cloneFlowIdstringasVersionbooleanendpointUristring (URL)
Example
curl -X POST "https://api.pozy.ai/v1/whatsapp/flows" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9",
"name": "Acme",
"categories": [
"SIGN_UP"
]
}'const res = await fetch("https://api.pozy.ai/v1/whatsapp/flows", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9",
name: "Acme",
categories: [
"SIGN_UP"
]
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/whatsapp/flows",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
"name": "Acme",
"categories": [
"SIGN_UP",
],
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanflowobjectidstringnamestringstatusstringcategoriesarray of stringversionintegerlineageIdstring
200 response
{
"success": true,
"flow": {
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"status": "active",
"categories": [
"string"
],
"version": 1,
"lineageId": "67937756276e8bad5f71c939"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.