WhatsApp · WhatsApp Flows
Sends a flow message.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
accountIdstringrequiredtostringrequiredflow_idstringrequiredflow_ctastringrequiredUp to 20 characters.
flow_actionstringOne of
navigate,data_exchange. Defaultnavigate.flow_tokenstringUp to 200 characters.
flow_action_payloadobjectscreenstringdataobject
bodystringrequiredheaderobjecttypestringOne of
text.textstring
footerstringdraftboolean
Example
curl -X POST "https://api.pozy.ai/v1/whatsapp/flows/send" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9",
"to": "+14155550123",
"flow_id": "6b3aa235a01c0fe058cfaf00",
"flow_cta": "string",
"body": "string"
}'const res = await fetch("https://api.pozy.ai/v1/whatsapp/flows/send", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9",
to: "+14155550123",
flow_id: "6b3aa235a01c0fe058cfaf00",
flow_cta: "string",
body: "string"
}),
});
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/send",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
"to": "+14155550123",
"flow_id": "6b3aa235a01c0fe058cfaf00",
"flow_cta": "string",
"body": "string",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanmessageIdstring
200 response
{
"success": true,
"messageId": "62d191e7089bc48b8ea56b35"
}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.