Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB
Tracking Settings

Update tracking settings

Updates the account-wide tracking defaults - open, click, and unsubscribe tracking, strict bot filtering, the default attribution window, and automatic UTM tagging - plus the double opt-in requirement for new contacts. Applies to emails sent afterwards; already-sent emails keep the links they were rendered with. Reply tracking is updated through the company endpoint.

patch/tracking-settings

Request body

openTrackingEnabledboolean

Whether to embed the open-tracking pixel.

clickTrackingEnabledboolean

Whether to rewrite links through the click-tracking redirect.

strictBotFilteringEnabledboolean

Opt-in aggressive bot detection (strict user-agent patterns, datacenter IPs, cross-send IP sweeps). Off by default; enabling it can lower reported open and click rates.

unsubscribeTrackingEnabledboolean

Whether unsubscribe links are attributed to the email that produced them.

defaultAttributionWindowHoursinteger

Default revenue attribution window in hours.

doubleOptInEnabledboolean

Whether new contacts must confirm by email before they become subscribed. This is the account-wide default that the per-request optInMode on subscriber creation overrides. Enabling it requires a sender profile and provisions the confirmation email automatically; it does not change contacts that are already active.

autoUtmEnabledboolean

Whether UTM parameters are appended to outbound links automatically. Enabling this with no stored parameters seeds the platform defaults.

Response

Tracking configuration updated

successboolean
messagestring

Example response

{
  "success": true
}