Tracking Settings

Update tracking settings

Changed on

Updates the account-wide and Transactional API 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

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/tracking-settings
  • Auth
    HTTP bearer

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 and Microsoft Azure IPs, fast campaign and sequence clicks from IPs clicking other recipients' emails, cross-send IP sweeps). Off by default; enabling it can lower reported open and click rates.

unsubscribeTrackingEnabledboolean

Whether to track unsubscribe link clicks. When false, Sequenzy unsubscribe links go directly to https://sequenzy.com, even with a custom tracking domain. Actual unsubscribes and their email attribution are still recorded.

emailContentStorageEnabledboolean

Whether to keep each sent email's rendered content and subject, and the IP address, user agent and country of opens and clicks. When false, sent-email records keep no body once the email is sent and store the email's name (campaign, template or sequence) in place of its subject, opens and clicks store no IP address, user agent or country, and view-in-browser links stop working. Body and subject rules apply to emails sent afterwards; IP address, user agent and country follow the setting at each open or click.

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.

doubleOptInRedirectUrlstring nullable

Where the hosted confirmation page sends subscribers after they confirm. Must be an http(s) URL of at most 500 characters after normalization; a bare domain is normalized to https. Null (or an empty string) clears it, keeping subscribers on the confirmation page branded with the company's name, logo, and colors.

autoUtmEnabledboolean

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

transactionalOpenTrackingEnabledboolean

Open tracking default for sends through the Send Email API. Account-wide open tracking must also be enabled; per-send trackingSettings can only opt out.

transactionalClickTrackingEnabledboolean

Click tracking default for sends through the Send Email API. Account-wide click tracking must also be enabled; per-send trackingSettings can only opt out.

Response

Tracking configuration updated

successboolean
messagestring

Example response

{
  "success": true
}

Changes

    • warning

      added the new custom enum value to the ///// response property for the response status

    • warning

      added the new sequenzy enum value to the ///// response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property became not nullable

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status