HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Update Tracking Setting

Update the tracking setting with the given account ID.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
tracking-settings:write

Path Params
string
required

The id of the tracking setting (account ID).

Body Params

DTO for updating tracking settings

object
required
string
required
string
required

The id of the tracking setting (account ID).

object
required
boolean

Whether tracking parameters are automatically added to campaigns and flows.

object

The utm_source tracking parameter.

The value of the tracking parameter when applied to a flow.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

The value of the tracking parameter when applied to a campaign.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

object

The utm_medium tracking parameter.

The value of the tracking parameter when applied to a flow.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

The value of the tracking parameter when applied to a campaign.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

object

The utm_campaign tracking parameter.

The value of the tracking parameter when applied to a flow.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

The value of the tracking parameter when applied to a campaign.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

object

The utm_id tracking parameter.

The value of the tracking parameter when applied to a flow.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

The value of the tracking parameter when applied to a campaign.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

object

The utm_term tracking parameter.

The value of the tracking parameter when applied to a flow.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

The value of the tracking parameter when applied to a campaign.

string
required

The type of the tracking parameter

string
required

The value of the tracking parameter

array of objects

List of custom tracking parameters.

custom_parameters

The value of the tracking parameter when applied to a flow.

The value of the tracking parameter when applied to a campaign.

string
required

The name of the custom tracking parameter

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials