On this page

Update Subscription Tracking Settings

API Overview

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.

Operation overview

PATCH/v3/tracking_settings/subscription

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 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.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Request body

Encoding type:application/json

Schema

Property nameTypeRequiredDescriptionChild properties

enabledbooleanOptional

Indicates if subscription tracking is enabled.

html_contentstringOptional

The information and HTML for your unsubscribe link.

landingstringOptional

The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server.

plain_contentstringOptional

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.

replacestringOptional

Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate.

urlstring<uri>Optional

The URL where you would like your users sent to unsubscribe.

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

enabledboolean

Indicates if subscription tracking is enabled.

html_contentstring

The information and HTML for your unsubscribe link.

landingstring

The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server.

plain_contentstring

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.

replacestring

Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate.

urlstring<uri>

The URL where you would like your users sent to unsubscribe.

Update Subscription Tracking Settings

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
5const request = {
6  url: `/v3/tracking_settings/subscription`,
7  method: 'PATCH',
8  
9}
10
11client.request(request)
12  .then(([response, body]) => {
13    console.log(response.statusCode);
14    console.log(response.body);
15  })
16  .catch(error => {
17    console.error(error);
18  });