Skip to main content
POST
Create Ads conversion rule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
channel
enum<string>
required

Channel this rule applies to.

Available options:
whatsapp,
facebook,
messenger,
instagram
eventType
enum<string>
required

Conversion event type this rule reports.

Available options:
lead,
purchase
trigger
object
required

Workspace event that fires this rule.

integrationWhatsappId
string | null

Restrict to this WhatsApp integration.

Pattern: ^\d+$
integrationFacebookAdsId
string | null

Restrict to this Facebook Ads integration.

Pattern: ^\d+$
integrationMessengerId
string | null

Restrict to this Messenger integration.

Pattern: ^\d+$
integrationInstagramId
string | null

Restrict to this Instagram integration.

Pattern: ^\d+$
adAccountId
string | null

Meta ad account id (act_) to report conversions to.

Minimum string length: 1
markAs
string | null

Label recorded on the conversion event for this rule.

Minimum string length: 1
enabled
boolean

Whether the rule is active.

Response

OK

id
string
required
Pattern: ^\d+$
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
channel
enum<string>
required
Available options:
whatsapp,
facebook,
messenger,
instagram
integrationWhatsappId
string | null
required
Pattern: ^\d+$
integrationFacebookAdsId
string | null
required
Pattern: ^\d+$
integrationMessengerId
string | null
required
Pattern: ^\d+$
integrationInstagramId
string | null
required
Pattern: ^\d+$
adAccountId
string | null
required
eventType
enum<string>
required
Available options:
lead,
purchase
trigger
object
required
markAs
string | null
required
enabled
boolean
required