Skip to main content
POST
Create custom UTM event

Headers

x-api-key
string
required

API key needed to authorize the request

Body

application/json
ai_contact_id
string
required
additional_params
object
required
customer_id
string | null
referrer_url
string | null
user_agent
string | null
ip_address
string | null
integration_type
enum<string> | null
Available options:
facebook,
google,
tiktok,
snapchat,
linkedin,
twitter,
pinterest,
bing,
facebook_whatsapp,
facebook_instagram,
facebook_messenger,
unknown
campaign_id
string | null
ad_set_id
string | null
ad_id
string | null
ad_source_click_id
string | null
utm_source
string
utm_medium
string
utm_term
string
utm_content
string
utm_referrer
string

Response

Event accepted for processing

success
boolean
Example:

true

message
string