Sign in

v1

latestOpenAPI 3.0.02026-07-2612645160.3 KB
UTM Events

Create custom UTM event

Queues a custom UTM event with user-defined fields. Only ai_contact_id is required; all other fields are optional. Accepts arbitrary JSON in additional_params.

post/api/public/utm-event/create

Headers

x-api-keystring required

API key needed to authorize the request

Request body

ai_contact_idstring required
customer_idstring nullable
referrer_urlstring nullable
user_agentstring nullable
ip_addressstring nullable
integration_type'facebook' | 'google' | 'tiktok' | 'snapchat' | 'linkedin' | 'twitter' | 'pinterest' | 'bing' | 'facebook_whatsapp' | 'facebook_instagram' | 'facebook_messenger' | 'unknown' nullable
campaign_idstring nullable
ad_set_idstring nullable
ad_idstring nullable
ad_source_click_idstring nullable
utm_sourcestring
utm_mediumstring
utm_termstring
utm_contentstring
utm_referrerstring
additional_paramsobject required

Response

Event accepted for processing

successboolean
messagestring

Example response

{
  "success": true
}