Skip to main content
POST
Send a conversion to an ad platform

Authorizations

x-api-key
string
header
required

Path Parameters

dealId
string
required
Minimum string length: 1

Body

application/json
provider
enum<string>
required

The ad platform that receives the conversion.

Available options:
META,
GOOGLE_ADS
event
string
required

The platform's standard name or any custom name. Meta's standard names (Lead, Contact, Schedule, Purchase, QualifiedLead…) are matched case-insensitively and sent the way the lead's origin expects: Lead goes out as LeadSubmitted for leads from a click-to-WhatsApp ad. Those leads only take Meta's business messaging names: a site's standard name follows messagingFallback, and a custom name goes out as a CRM event. Purchase takes its value from the deal price. On Google Ads it is the id of a conversion action of the project's account, of the import-from-clicks kind (GET /connections/google-ads/conversion-actions lists them), and any conversion takes the deal price as its value.

Required string length: 1 - 50
pixelId
string

Meta: the pixel (dataset) a CRM or site event goes to, one the project's Meta Ads connection was granted (GET /connections/meta-ads/pixels lists them). An event of a click-to-WhatsApp ad conversation goes to the dataset of its WhatsApp account instead. Without it, only those go out, through the WhatsApp Business channel.

Pattern: ^\d+$
messagingFallback
enum<string>

For a lead from a click-to-WhatsApp ad, what to do with a site's standard event, which Meta's business messaging does not take (Schedule, Contact…). CRM, the default, sends it as a CRM event, matched by phone, email and cookies but no longer tied to the ad click. SKIP sends nothing and answers SKIPPED with UNSUPPORTED_EVENT. A custom name always goes out as a CRM event. Meta only.

Available options:
CRM,
SKIP
testEventCode
string

Meta: the code from the Test Events tab in Meta Events Manager; test events still count as real data in Meta. Google Ads: any value has Google only validate the conversion, which it does not record.

Minimum string length: 1

Response

Success

status
string
required
Allowed value: "QUEUED"
conversionId
string
required
eventName
string
required

The name the platform will receive.

scheduledFor
string

Google Ads: when the send goes out, ISO 8601, set when the click is too recent for Google to take it yet.