Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

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


GET/v3/tracking_settings/subscription

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve 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.


Authentication

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

on-behalf-ofstring

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.

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

Retrieve Subscription Tracking Settings

retrieve-subscription-tracking-settings page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/tracking_settings/subscription`,
_18
method: 'GET',
_18
_18
}
_18
_18
client.request(request)
_18
.then(([response, body]) => {
_18
console.log(response.statusCode);
_18
console.log(response.body);
_18
})
_18
.catch(error => {
_18
console.error(error);
_18
});


Rate this page: