SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Suppressions Global Suppressions API

5 actions 5 updates phrasing extends openapi/sendgrid-global-suppressions-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 5

$.info
$.paths['/v3/asm/suppressions/global'].post
$.paths['/v3/asm/suppressions/global/{email}'].get
$.paths['/v3/asm/suppressions/global/{email}'].delete
$.paths['/v3/suppression/unsubscribes'].get

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 Suppressions Global Suppressions API
  version: 1.0.0
extends: openapi/sendgrid-global-suppressions-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: 4
- target: $.paths['/v3/asm/suppressions/global'].post
  update:
    x-apievangelist-phrasing:
      intent: Globally unsubscribe email addresses
      effect: write
      questions:
      - Can I stop all email to certain addresses across every group?
      - Is there a way to add several people to the global unsubscribe list at once?
      instructions:
      - text: Globally suppress {recipient_emails}.
        slots:
          recipient_emails: requestBody.recipient_emails
      - text: Add {recipient_emails} to my global unsubscribe list.
        slots:
          recipient_emails: requestBody.recipient_emails
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/suppressions/global/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an address is globally suppressed
      effect: read
      questions:
      - Is a specific address on my global unsubscribe list?
      - Can I confirm someone has globally opted out before I email them?
      instructions:
      - text: Check whether {email} is globally suppressed.
        slots:
          email: path.email
      - text: Look up the global suppression for {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/asm/suppressions/global/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an address from global suppressions
      effect: destructive
      questions:
      - Can I resume sending to someone who globally unsubscribed?
      - What happens when I take an email off the global unsubscribe list?
      instructions:
      - text: Remove {email} from global suppressions.
        slots:
          email: path.email
      - text: Delete the global unsubscribe for {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/unsubscribes'].get
  update:
    x-apievangelist-phrasing:
      intent: List all globally suppressed addresses
      effect: read
      questions:
      - Who has unsubscribed from all of my email?
      - Can I list global unsubscribes within a date range?
      instructions:
      - text: List all globally suppressed addresses.
      - text: Show global unsubscribes between {start_time} and {end_time}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
      - text: Search global suppressions for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-24'