Menu

Rate this page:

Settings - Tracking

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.

Retrieve Subscription Tracking Settings

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

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Responses

object
enabled
boolean

Indicates if subscription tracking is enabled.

html_content
string

The information and HTML for your unsubscribe link.

landing
string

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

plain_content
string

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.

replace
string

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

url
string

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

format: uri
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

              
              
              

              Thank you for your feedback!

              We are always striving to improve our documentation quality, and your feedback is valuable to us. Please select the reason(s) for your feedback or provide additional information about how we can improve:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more