WhatsApp Flows

Send flow message — estimate

Price the request without executing it. Same body as POST /v1/messaging/whatsapp/flows/send.

post/v1/messaging/whatsapp/flows/send/estimate

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/whatsapp/flows/send/estimate
  • Auth: HTTP bearer

Request body

tostring required

Recipient phone number (E.164 format, e.g. +1234567890)

bodystring required

Message body text

draftboolean

Set true to test an unpublished (DRAFT) flow

footerstring

Optional footer text

flow_idstring required

Published flow ID

flow_ctastring required

CTA button text (e.g. 'Book Now', 'Sign Up')

accountIdstring required

WhatsApp account ID

flow_tokenstring

Unique token to correlate responses. If omitted, auto-generated as '<flowId>:<uuid>' so the response can be attributed to this flow in the Flow Responses view.

flow_action'navigate' | 'data_exchange'

Action type: navigate opens a screen directly, data_exchange hits your endpoint first

Response

Estimate

operationstring
estimated_creditsnumber
credits_to_reservenumber
estimated_usageobject
notestring nullable
sufficientboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.