Send conversion events of WhatsApp chats
https://api.app2email.com/v1/{number}/conversions/events Up to 1,000 events to the account's dataset (eg a Purchase after a click-to-WhatsApp ad). Defaults: action_source, messaging_channel, the WABA id.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Body application/json required
-
6 item fields
-
eg Purchase, LeadSubmitted, AddToCart.
- event_time integer
Unix seconds, within the last 7 days. Default: now.
-
2 fields
- ctwa_clid string
The click id of the click-to-WhatsApp ad (referral.ctwa_clid of the contact's first message).
- whatsapp_business_account_id string
Default: this number's WABA.
-
- test_event_code string
From Events Manager: the events show under Test events and are not used for ads.
- partner_agent string
Responses
Fields
- e.g.
true - e.g.
a1n2l - dataset_id string
- events_received integer
- messages string[]
- fbtrace_id 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.
- 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.