One flow: status, validation errors, health
https://api.app2email.com/v1/{number}/flows/{id} Status, categories, validation errors, Flow JSON version, endpoint, and whether it can be sent (health_status).
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 id (digits).
e.g.1234567890123456
Responses
Fields
- success boolean
- request_id string
- flow object
12 fields
- id string
- name string
- status string
DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED - categories string[]
SIGN_UPSIGN_INAPPOINTMENT_BOOKINGLEAD_GENERATIONCONTACT_USCUSTOMER_SUPPORTSURVEYOTHER - validation_errors object[]
8 item fields
- error string
- error_type string
- message string
- line_start integer
- line_end integer
- column_start integer
- column_end integer
- pointers object[]
- json_version string
- data_api_version string
- endpoint_uri string
-
can_send_message (AVAILABLE | LIMITED | BLOCKED) per entity, with errors.
- key string
GET /flows only: one of this number's Book-and-Pay Flows; POST /flows/{key}/send takes the key. Left out for other Flows.
e.g.booking - can_send boolean
GET /flows, a Book-and-Pay Flow: POST /flows/{key}/send works now (enabled and published).
- booking_flow object
GET /flows, a Book-and-Pay Flow: the Flow as the Book-and-Pay section has it (status in its words).
14 fields
- key string
The Flow's key: what POST /flows/{key}/send takes.
e.g.booking - name stringe.g.
Appointment booking - kind string
bookingform - enabled boolean
- is_default boolean
The Flow the generic trigger words send.
- trigger_keywords string[]
Words that send this Flow.
- id string
Meta's id of the Flow, once uploaded.
- status string
Meta's status. Only a published Flow can be sent.
nonedraftpublisheddeprecatedblockedthrottlederror - can_send boolean
enabled and published.
- health string
Meta's health word: AVAILABLE, LIMITED, BLOCKED, or empty.
- validation string
Meta's validation problems in words, when there are any.
- last_error string
- last_published_at string
- updated_at string (date-time)
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.
- 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.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.