Send a Flow to a contact (the booking form or another form)
https://api.app2email.com/v1/{number}/flows/{key}/send Scope: bookings:manage. Not with a sandbox key. A Flow of the number's Book-and-Pay section, by its key (GET /flows). A Flow message is free-form: it can only go to a contact who wrote to the number in the last 24 hours (422 outside_24h_window; send an approved template first, then the Flow when they answer). The Flow must be enabled and published (409 flow_not_published). The contact's answers come back as booking.created (a booking Flow) or flow.completed (a form Flow). Counts as one message of the plan.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The Flow's key (GET /flows).
e.g.booking
Body application/json required
-
The contact's WhatsApp number with country code, digits only, or their business-scoped user id. They must have written to the number in the last 24 hours.
e.g.61412345678 -
reschedule: move the contact's next appointment (a booking Flow only).
bookreschedule
Responses
Fields
- success boolean
- request_id string
- sent boolean
- message_id string
WhatsApp message id of the Flow message.
- session_id integer
The Flow session: booking.created / flow.completed name it.
- flow object
- contact string
- purpose string
- note string
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
- 415 The body is not JSON.
- 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 502 WhatsApp (Meta) returned an error or could not be reached.