WhatsApp · WhatsApp Flows

Send flow message

Sends a flow message.

POSThttps://api.pozy.ai/v1/whatsapp/flows/send
sendWhatsAppFlowMessage

Guide: WhatsApp Flows

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

  • accountIdstringrequired
  • tostringrequired
  • flow_idstringrequired
  • flow_ctastringrequired

    Up to 20 characters.

  • flow_actionstring

    One of navigate, data_exchange. Default navigate.

  • flow_tokenstring

    Up to 200 characters.

  • flow_action_payloadobject
    • screenstring
    • dataobject
  • bodystringrequired
  • headerobject
    • typestring

      One of text.

    • textstring
  • footerstring
  • draftboolean

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"
}'

Response

200 on success

  • successboolean
  • messageIdstring
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:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in WhatsApp Flows