Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Email Suppressions API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/suppression/bounces'].get
$.paths['/suppression/bounces'].delete
$.paths['/suppression/blocks'].get
$.paths['/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 Email Suppressions API
  version: 1.0.0
extends: openapi/twilio-suppressions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/suppression/bounces'].get
  update:
    x-apievangelist-phrasing:
      intent: List email addresses that bounced
      effect: read
      questions:
      - Which email addresses have bounced my messages recently?
      - Can I see bounces only within a certain time window?
      instructions:
      - text: List bounced email addresses.
      - text: Show bounces between {start_time} and {end_time}, up to {limit} results.
        slots:
          start_time: query.start_time
          end_time: query.end_time
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppression/bounces'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear addresses from the bounce list
      effect: destructive
      questions:
      - Can I remove a fixed address from my bounce list so mail reaches it again?
      - Is there a way to wipe the entire bounce list in one call?
      instructions:
      - text: Remove {emails} from my bounce list.
        slots:
          emails: requestBody.emails
      - text: Clear every bounce by setting delete all to {delete_all}.
        slots:
          delete_all: requestBody.delete_all
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppression/blocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List email addresses that are blocked
      effect: read
      questions:
      - Which recipients' mail servers have blocked my email?
      - Can I see blocked addresses from just the last week?
      instructions:
      - text: List blocked email addresses.
      - text: Show blocks recorded between {start_time} and {end_time}, at most {limit}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppression/unsubscribes'].get
  update:
    x-apievangelist-phrasing:
      intent: List globally unsubscribed recipients
      effect: read
      questions:
      - Who has unsubscribed from all of my email?
      - Can I pull global unsubscribes for a specific date range?
      instructions:
      - text: List everyone on my global unsubscribe list.
      - text: Show global unsubscribes from {start_time} to {end_time}, limited to {limit}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
          limit: query.limit
      method: generated
      generated: '2026-09-26'