SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Suppressions Invalid Emails API

5 actions 5 updates phrasing extends openapi/sendgrid-invalid-emails-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/suppression/invalid_emails'].get
$.paths['/v3/suppression/invalid_emails'].delete
$.paths['/v3/suppression/invalid_emails/{email}'].get
$.paths['/v3/suppression/invalid_emails/{email}'].delete

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 Invalid Emails API
  version: 1.0.0
extends: openapi/sendgrid-invalid-emails-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/suppression/invalid_emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List invalid email addresses
      effect: read
      questions:
      - Which addresses were rejected as invalid or malformed?
      - Can I see invalid emails added within a time window?
      instructions:
      - text: List all invalid email addresses.
      - text: Show invalid emails recorded between {start_time} and {end_time}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
      - text: Find invalid addresses matching {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/invalid_emails'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several or all invalid emails
      effect: destructive
      questions:
      - Can I wipe my whole invalid email list in one go?
      - What are the two ways to clear invalid addresses in bulk?
      instructions:
      - text: Remove {emails} from my invalid email list.
        slots:
          emails: requestBody.emails
      - text: Delete every invalid email with delete_all {delete_all}.
        slots:
          delete_all: requestBody.delete_all
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/invalid_emails/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an address is marked invalid
      effect: read
      questions:
      - Why isn't mail reaching one address, is it on the invalid list?
      - What reason was recorded for a specific invalid email?
      instructions:
      - text: Look up the invalid email entry for {email}.
        slots:
          email: path.email
      - text: Check whether {email} is flagged as invalid.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/invalid_emails/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one address from the invalid list
      effect: destructive
      questions:
      - I fixed a typo in a customer's address, how do I take the old entry off the invalid list?
      - Can I clear a single address from invalid emails?
      instructions:
      - text: Remove {email} from the invalid email list.
        slots:
          email: path.email
      - text: Delete the single invalid email entry for {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'