SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Mail Mail Batch API

3 actions 3 updates phrasing extends openapi/sendgrid-mail-batch-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 3

$.info
$.paths['/v3/mail/batch'].post
$.paths['/v3/mail/batch/{batch_id}'].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 Mail Mail Batch API
  version: 1.0.0
extends: openapi/sendgrid-mail-batch-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: 2
- target: $.paths['/v3/mail/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mail batch ID
      effect: write
      questions:
      - How do I group several mail sends so I can pause or cancel them together?
      - Where do I get a new batch ID for scheduled mail?
      instructions:
      - text: Create a new mail batch ID.
      - text: Generate a batch ID I can attach to upcoming sends.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/mail/batch/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Validate a mail batch ID
      effect: read
      questions:
      - Is a particular batch ID still valid?
      - What happens if I check an invalid batch ID?
      instructions:
      - text: Validate batch ID {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Check that mail batch {batch_id} exists.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-24'