Update Tracking Settings

PATCH

api

tracking-settings

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/tracking-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "openTrackingEnabled": true,
  "clickTrackingEnabled": true,
  "strictBotFilteringEnabled": true,
  "unsubscribeTrackingEnabled": true,
  "defaultAttributionWindowHours": 123,
  "autoUtmEnabled": true,
  "autoUtmSettings": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/tracking-settings"

payload = {
    "openTrackingEnabled": True,
    "clickTrackingEnabled": True,
    "strictBotFilteringEnabled": True,
    "unsubscribeTrackingEnabled": True,
    "defaultAttributionWindowHours": 123,
    "autoUtmEnabled": True,
    "autoUtmSettings": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    openTrackingEnabled: true,
    clickTrackingEnabled: true,
    strictBotFilteringEnabled: true,
    unsubscribeTrackingEnabled: true,
    defaultAttributionWindowHours: 123,
    autoUtmEnabled: true,
    autoUtmSettings: {}
  })
};

fetch('https://api.sequenzy.com/api/v1/tracking-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/tracking-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'openTrackingEnabled' => true,
    'clickTrackingEnabled' => true,
    'strictBotFilteringEnabled' => true,
    'unsubscribeTrackingEnabled' => true,
    'defaultAttributionWindowHours' => 123,
    'autoUtmEnabled' => true,
    'autoUtmSettings' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/tracking-settings"

	payload := strings.NewReader("{\n  \"openTrackingEnabled\": true,\n  \"clickTrackingEnabled\": true,\n  \"strictBotFilteringEnabled\": true,\n  \"unsubscribeTrackingEnabled\": true,\n  \"defaultAttributionWindowHours\": 123,\n  \"autoUtmEnabled\": true,\n  \"autoUtmSettings\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sequenzy.com/api/v1/tracking-settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"openTrackingEnabled\": true,\n  \"clickTrackingEnabled\": true,\n  \"strictBotFilteringEnabled\": true,\n  \"unsubscribeTrackingEnabled\": true,\n  \"defaultAttributionWindowHours\": 123,\n  \"autoUtmEnabled\": true,\n  \"autoUtmSettings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/tracking-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"openTrackingEnabled\": true,\n  \"clickTrackingEnabled\": true,\n  \"strictBotFilteringEnabled\": true,\n  \"unsubscribeTrackingEnabled\": true,\n  \"defaultAttributionWindowHours\": 123,\n  \"autoUtmEnabled\": true,\n  \"autoUtmSettings\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Updated tracking settings: openTrackingEnabled, clickTrackingEnabled.",
  "tracking": {
    "openTrackingEnabled": false,
    "clickTrackingEnabled": false,
    "strictBotFilteringEnabled": false,
    "unsubscribeTrackingEnabled": true,
    "defaultAttributionWindowHours": 24
  },
  "autoUtm": {
    "enabled": false,
    "settings": {}
  },
  "trackingDomain": null,
  "replyTracking": {
    "inboundEmailEnabled": true,
    "inboundReplyDomainMode": "sequenzy",
    "forwardReplies": true
  }
}

{
  "success": false,
  "error": "defaultAttributionWindowHours must be a whole number between 1 and 720."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: companies:manage"
}

{
  "success": false,
  "error": "Company not found"
}

Update how a company measures email engagement: open, click, and unsubscribe tracking, the default attribution window, and automatic UTM tagging. Changes apply to every campaign, sequence, and transactional email sent afterwards. Already-sent emails keep the links and pixels they were rendered with. Provide at least one field. Reply tracking (replyTrackingEnabled, replyTrackingDomainMode, forwardReplies) is updated through Update Company, and the dedicated click-tracking domain is configured in the dashboard. Requires the companies:manage scope.

Request

boolean

Whether to embed the open-tracking pixel. Turning this off also stops open rates from being recorded.

boolean

Whether to rewrite links through the click-tracking redirect. Turning this off stops click rates and click-based automation triggers.

boolean

Opt-in aggressive bot detection: strict user-agent patterns, datacenter-IP classification, and cross-send IP sweeps. Off by default. Enabling it filters more security-scanner traffic but can also discard some real engagement, lowering reported open and click rates.

boolean

Whether unsubscribe links are attributed to the email that produced them. Unsubscribe links keep working either way.

integer

Default revenue attribution window in hours, between 1 and 720.

boolean

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

object

UTM templates - source, medium, campaign, content, term - merged over the stored ones. Values support placeholders such as {{email.subject}} and {{link.text}}. Set a field to null to stop emitting that parameter, or send null for the whole object to reset every parameter to the platform defaults.

curl -X PATCH "https://api.sequenzy.com/api/v1/tracking-settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"openTrackingEnabled": false, "clickTrackingEnabled": false}'

Responses

The full tracking configuration is returned after the update, in the same shape as Get Tracking Settings.

{
  "success": true,
  "message": "Updated tracking settings: openTrackingEnabled, clickTrackingEnabled.",
  "tracking": {
    "openTrackingEnabled": false,
    "clickTrackingEnabled": false,
    "strictBotFilteringEnabled": false,
    "unsubscribeTrackingEnabled": true,
    "defaultAttributionWindowHours": 24
  },
  "autoUtm": {
    "enabled": false,
    "settings": {}
  },
  "trackingDomain": null,
  "replyTracking": {
    "inboundEmailEnabled": true,
    "inboundReplyDomainMode": "sequenzy",
    "forwardReplies": true
  }
}

{
  "success": false,
  "error": "defaultAttributionWindowHours must be a whole number between 1 and 720."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: companies:manage"
}

{
  "success": false,
  "error": "Company not found"
}

Create SubscriberCreate a new subscriber or update an existing one based on duplicate strategy

Update Tracking Settings

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/tracking-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "openTrackingEnabled": true,
  "clickTrackingEnabled": true,
  "strictBotFilteringEnabled": true,
  "unsubscribeTrackingEnabled": true,
  "defaultAttributionWindowHours": 123,
  "autoUtmEnabled": true,
  "autoUtmSettings": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/tracking-settings"

payload = {
    "openTrackingEnabled": True,
    "clickTrackingEnabled": True,
    "strictBotFilteringEnabled": True,
    "unsubscribeTrackingEnabled": True,
    "defaultAttributionWindowHours": 123,
    "autoUtmEnabled": True,
    "autoUtmSettings": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    openTrackingEnabled: true,
    clickTrackingEnabled: true,
    strictBotFilteringEnabled: true,
    unsubscribeTrackingEnabled: true,
    defaultAttributionWindowHours: 123,
    autoUtmEnabled: true,
    autoUtmSettings: {}
  })
};

fetch('https://api.sequenzy.com/api/v1/tracking-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/tracking-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'openTrackingEnabled' => true,
    'clickTrackingEnabled' => true,
    'strictBotFilteringEnabled' => true,
    'unsubscribeTrackingEnabled' => true,
    'defaultAttributionWindowHours' => 123,
    'autoUtmEnabled' => true,
    'autoUtmSettings' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/tracking-settings"

	payload := strings.NewReader("{\n  \"openTrackingEnabled\": true,\n  \"clickTrackingEnabled\": true,\n  \"strictBotFilteringEnabled\": true,\n  \"unsubscribeTrackingEnabled\": true,\n  \"defaultAttributionWindowHours\": 123,\n  \"autoUtmEnabled\": true,\n  \"autoUtmSettings\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sequenzy.com/api/v1/tracking-settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"openTrackingEnabled\": true,\n  \"clickTrackingEnabled\": true,\n  \"strictBotFilteringEnabled\": true,\n  \"unsubscribeTrackingEnabled\": true,\n  \"defaultAttributionWindowHours\": 123,\n  \"autoUtmEnabled\": true,\n  \"autoUtmSettings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/tracking-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"openTrackingEnabled\": true,\n  \"clickTrackingEnabled\": true,\n  \"strictBotFilteringEnabled\": true,\n  \"unsubscribeTrackingEnabled\": true,\n  \"defaultAttributionWindowHours\": 123,\n  \"autoUtmEnabled\": true,\n  \"autoUtmSettings\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Updated tracking settings: openTrackingEnabled, clickTrackingEnabled.",
  "tracking": {
    "openTrackingEnabled": false,
    "clickTrackingEnabled": false,
    "strictBotFilteringEnabled": false,
    "unsubscribeTrackingEnabled": true,
    "defaultAttributionWindowHours": 24
  },
  "autoUtm": {
    "enabled": false,
    "settings": {}
  },
  "trackingDomain": null,
  "replyTracking": {
    "inboundEmailEnabled": true,
    "inboundReplyDomainMode": "sequenzy",
    "forwardReplies": true
  }
}

{
  "success": false,
  "error": "defaultAttributionWindowHours must be a whole number between 1 and 720."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: companies:manage"
}

{
  "success": false,
  "error": "Company not found"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Update Tracking Settings

Request

Responses

​Request

​Responses

Request

Responses