You can track many of your recipients' interactions with your emails, including:
For more information about tracking, please see our Tracking Settings documentation.
This endpoint allows you to update your current settings for subscription tracking.
Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.
Bearer <<YOUR_API_KEY_HERE>>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.
application/jsonOptional
Indicates if subscription tracking is enabled.
Optional
The information and HTML for your unsubscribe link.
Optional
The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server.
Optional
The information in plain text for your unsubscribe link. You should have the “<% %>” tag in your content, otherwise the user will have no URL for unsubscribing.
Optional
Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate.
Optional
The URL where you would like your users sent to unsubscribe.
Indicates if subscription tracking is enabled.
The information and HTML for your unsubscribe link.
The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server.
The information in plain text for your unsubscribe link. You should have the “<% %>” tag in your content, otherwise the user will have no URL for unsubscribing.
Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate.
The URL where you would like your users sent to unsubscribe.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const request = {5url: `/v3/tracking_settings/subscription`,6method: "PATCH",7};89client10.request(request)11.then(([response, body]) => {12console.log(response.statusCode);13console.log(response.body);14})15.catch((error) => {16console.error(error);17});