Skip to contentSkip to navigationSkip to topbar
On this page

Update Click Tracking Settings



API Overview

api-overview page anchor

You can track many of your recipients' interactions with your emails, including:

  • Opening emails
  • Clicking links
  • Subscribing to (or unsubscribing from) your emails

For more information about tracking, please see our Tracking Settings documentation.


PATCH/v3/tracking_settings/click

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to enable or disable your current click tracking setting.

Click Tracking overrides all the links and URLs in your emails and points them to either SendGrid’s servers or the domain with which you branded your link. When a customer clicks a link, SendGrid tracks those clicks.

Click tracking helps you understand how users are engaging with your communications. SendGrid can track up to 1000 links per email


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

Optional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
enabledboolean

Optional

The setting you want to use for click tracking.

200
SchemaExample
Property nameTypeRequiredDescriptionChild properties
enable_textboolean

Indicates if click tracking is enabled for plain text emails.


enabledboolean

Indicates if click tracking is enabled or disabled.

Update Click Tracking SettingsLink to code sample: Update Click Tracking Settings
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const data = {
5
enabled: true,
6
};
7
8
const request = {
9
url: `/v3/tracking_settings/click`,
10
method: "PATCH",
11
body: data,
12
};
13
14
client
15
.request(request)
16
.then(([response, body]) => {
17
console.log(response.statusCode);
18
console.log(response.body);
19
})
20
.catch((error) => {
21
console.error(error);
22
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.