provider Settings - Tracking PATCH /tracking_settings/subscription
@utdk/sendgrid /tracking_settings/subscription
Update Subscription Tracking Settings
**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.
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

patchTrackingSettingsSubscription
PATCH/tracking_settings/subscription
**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.

Input

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.patchTrackingSettingsSubscription({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})