WhatsApp

Send a conversion event

Reports an outcome back to Meta for Click-to-WhatsApp ad optimization, against a chat whose ctwa_clid was captured.

post/api/profiles/{profile_id}/whatsapp/send_conversion_event

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/profiles/{profile_id}/whatsapp/send_conversion_event
  • Auth
    HTTP bearer

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

Request body

event_name'LeadSubmitted' | 'Purchase' | 'AddToCart' | 'InitiateCheckout' | 'ViewContent' required
event_idstring required

Your unique id for the event; Meta dedupes on it.

chat_idstring

The chat the customer arrived in. One of chat_id or phone is required.

phonestring

The customer’s phone number instead; the most recently active chat with it is used.

valuenumber
currencystring

ISO 4217 code, e.g. USD.

content_idsstring[]
emailstring

SHA-256 hashed before it leaves Postproxy.

external_idstring

Your customer id. SHA-256 hashed before it leaves Postproxy.

test_codestring

Meta test event code, to see the event in Events Manager without affecting optimization.

dataset_idstring

Send to a specific dataset instead of the account’s own.

Response

Meta’s ingestion result.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.