SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Email Address Validation Bulk Email Address…

4 actions 4 updates phrasing extends openapi/sendgrid-bulk-email-address-validation-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 4

$.info
$.paths['/v3/validations/email/jobs'].get
$.paths['/v3/validations/email/jobs'].put
$.paths['/v3/validations/email/jobs/{job_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 Email Address Validation Bulk Email Address…
  version: 1.0.0
extends: openapi/sendgrid-bulk-email-address-validation-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: 3
- target: $.paths['/v3/validations/email/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk email validation jobs
      effect: read
      questions:
      - What bulk email validation jobs have I run?
      - Can I see all my bulk address validation jobs in one place?
      instructions:
      - text: List all my bulk email validation jobs.
      - text: Show every bulk address validation job on my account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/validations/email/jobs'].put
  update:
    x-apievangelist-phrasing:
      intent: Get an upload URL for a bulk validation list
      effect: write
      questions:
      - How do I upload a file of email addresses to validate in bulk?
      - Which file types can I upload for bulk email validation?
      instructions:
      - text: Get a presigned upload URL for a {file_type} list of emails to validate.
        slots:
          file_type: requestBody.file_type
      - text: Start a bulk validation upload for a {file_type} file.
        slots:
          file_type: requestBody.file_type
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/validations/email/jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk email validation job
      effect: read
      questions:
      - Is my bulk email validation job finished yet?
      - How far along is a particular validation job?
      instructions:
      - text: Check the progress of validation job {job_id}.
        slots:
          job_id: path.job_id
      - text: Get bulk validation job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-24'