SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Suppressions Blocks API

5 actions 5 updates phrasing extends openapi/sendgrid-blocks-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/blocks'].get
$.paths['/v3/suppression/blocks'].delete
$.paths['/v3/suppression/blocks/{email}'].get
$.paths['/v3/suppression/blocks/{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 Blocks API
  version: 1.0.0
extends: openapi/sendgrid-blocks-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/blocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List blocked email addresses
      effect: read
      questions:
      - Which addresses are on my blocks list because their servers rejected my mail?
      - Can I see blocks added within a certain time window?
      instructions:
      - text: List my blocked email addresses.
      - text: Show blocks between {start_time} and {end_time}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
      - text: Search the blocks list for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/blocks'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many or all blocks
      effect: destructive
      questions:
      - Can I clear my entire blocks list in one go?
      - Is it possible to remove a batch of addresses from blocks at once?
      instructions:
      - text: 'Delete all blocks: {delete_all}.'
        slots:
          delete_all: requestBody.delete_all
      - text: Remove {emails} from my blocks list.
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/blocks/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific block
      effect: read
      questions:
      - Is a particular address on my blocks list, and why?
      - When was a given email added to blocks?
      instructions:
      - text: Show the block for {email}.
        slots:
          email: path.email
      - text: Check whether {email} is blocked.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/blocks/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a specific block
      effect: destructive
      questions:
      - Can I unblock a single address so it gets mail again?
      - What's the step to take just one email off my blocks list?
      instructions:
      - text: Unblock {email}.
        slots:
          email: path.email
      - text: Delete the block for {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'