Menu

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

Update Subscription Tracking Settings

PATCH /v3/tracking_settings/subscription

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

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.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string

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.

default: None

Request Body

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

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
Loading Code Sample...
        
        

        Update Subscription Tracking Settings

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

              Thanks for your feedback!

              thanks-feedback-gif