Skip to main content
PUT
Update campaign tracker additions and overrides

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

campaignId
string
required

Unique public campaign identifier

Minimum string length: 1
Example:

"cmp_987654321"

Body

application/json

Campaign-local tracker additions and overrides of advertiser defaults

expected_revision
integer

Last-read campaign_revision. Rejects concurrent tracking updates.

Required range: 0 <= x <= 9007199254740991
custom_tracker_urls
object[]

Campaign-local trackers added after inherited advertiser trackers

Maximum array length: 10
tracker_overrides
object[]
Maximum array length: 50
macro_additions
object[]

Campaign click-URL query parameters. Same-key entries override advertiser defaults; null suppresses an inherited key.

Maximum array length: 50
auto_utm
boolean

Whether Apostra adds its own UTM tags (utm_source, utm_medium, utm_campaign, utm_content) to this campaign's click URLs. Defaults to true. false turns all four off for the campaign; it does not remove parameters you set in macro_additions or in the click-through URL. Takes effect where site analytics outcomes is on for the account.

Response

Update campaign tracker additions and overrides

Response containing campaign-local tracker settings and the effective inherited set

data
object
required

Campaign tracker configuration plus the fully resolved inherited tracker set