SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Settings Tracking API

10 actions 10 updates phrasing extends openapi/sendgrid-tracking-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/v3/tracking_settings'].get
$.paths['/v3/tracking_settings/click'].get
$.paths['/v3/tracking_settings/click'].patch
$.paths['/v3/tracking_settings/google_analytics'].get
$.paths['/v3/tracking_settings/google_analytics'].patch
$.paths['/v3/tracking_settings/open'].get
$.paths['/v3/tracking_settings/open'].patch
$.paths['/v3/tracking_settings/subscription'].get
$.paths['/v3/tracking_settings/subscription'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Settings Tracking API
  version: 1.0.0
extends: openapi/sendgrid-tracking-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/v3/tracking_settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tracking settings
      effect: read
      questions:
      - Which email tracking features are turned on for my account?
      - Can I see all my tracking settings in one place?
      instructions:
      - text: List all my tracking settings.
      - text: Show every email tracking setting on my account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/click'].get
  update:
    x-apievangelist-phrasing:
      intent: Get click tracking setting
      effect: read
      questions:
      - Is click tracking currently enabled on my emails?
      - Are the links in my emails being rewritten to track clicks right now?
      instructions:
      - text: Show my click tracking setting.
      - text: Check whether click tracking is on.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/click'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn click tracking on or off
      effect: write
      questions:
      - Can I stop SendGrid from rewriting the links in my emails?
      - What's needed to enable click tracking across my account?
      instructions:
      - text: Set click tracking enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Turn off click tracking.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/google_analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Google Analytics tracking setting
      effect: read
      questions:
      - Are UTM parameters being added to my email links for Google Analytics?
      - What UTM source and campaign values am I currently using?
      instructions:
      - text: Show my Google Analytics tracking setting.
      - text: Get my current UTM tracking values.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/google_analytics'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update Google Analytics UTM tracking
      effect: write
      questions:
      - Can I automatically tag my email links with UTM parameters for Google Analytics?
      - Is it possible to change the utm_campaign name added to my links?
      instructions:
      - text: Enable Google Analytics tracking with source {utm_source} and medium {utm_medium}.
        slots:
          utm_source: requestBody.utm_source
          utm_medium: requestBody.utm_medium
      - text: Set the UTM campaign on my email links to {utm_campaign}.
        slots:
          utm_campaign: requestBody.utm_campaign
      - text: Set Google Analytics tracking enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/open'].get
  update:
    x-apievangelist-phrasing:
      intent: Get open tracking setting
      effect: read
      questions:
      - Is open tracking turned on for my account?
      - Am I currently adding a tracking pixel to my emails?
      instructions:
      - text: Show my open tracking setting.
      - text: Check whether open tracking is enabled.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/open'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn open tracking on or off
      effect: write
      questions:
      - Can I disable the invisible image that tracks email opens?
      - What's the switch to start tracking opens on my emails?
      instructions:
      - text: Set open tracking enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Turn on open tracking.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subscription tracking setting
      effect: read
      questions:
      - Are unsubscribe links being added to the bottom of my emails?
      - What landing page and footer text does my subscription tracking use?
      instructions:
      - text: Show my subscription tracking setting.
      - text: Get my current unsubscribe footer settings.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/tracking_settings/subscription'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update subscription tracking footer
      effect: write
      questions:
      - Can I customize the unsubscribe footer that's added to my emails?
      - Is it possible to send unsubscribers to my own landing page URL?
      instructions:
      - text: Set subscription tracking enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Send unsubscribers to {url} instead of the default landing page.
        slots:
          url: requestBody.url
      - text: Set the unsubscribe footer HTML to {html_content} and text to {plain_content}.
        slots:
          html_content: requestBody.html_content
          plain_content: requestBody.plain_content
      method: generated
      generated: '2026-09-24'