Settings: Subscription Tracking

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sendgrid/main/json-schema/sendgrid-subscription-tracking-settings-schema.json",
  "title": "Settings: Subscription Tracking",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sendgrid-tracking-api-openapi.yml#/components/schemas/SubscriptionTrackingSettings",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates if subscription tracking is enabled."
    },
    "html_content": {
      "type": "string",
      "description": "The information and HTML for your unsubscribe link. "
    },
    "landing": {
      "type": "string",
      "description": "The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server."
    },
    "plain_content": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate."
    },
    "url": {
      "type": "string",
      "description": "The URL where you would like your users sent to unsubscribe.",
      "format": "uri"
    }
  }
}