SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Verified Senders Sender Verification API

9 actions 9 updates phrasing extends openapi/sendgrid-sender-verification-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 9

$.info
$.paths['/v3/verified_senders'].get
$.paths['/v3/verified_senders'].post
$.paths['/v3/verified_senders/{id}'].delete
$.paths['/v3/verified_senders/{id}'].patch
$.paths['/v3/verified_senders/domains'].get
$.paths['/v3/verified_senders/resend/{id}'].post
$.paths['/v3/verified_senders/steps_completed'].get
$.paths['/v3/verified_senders/verify/{token}'].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 Verified Senders Sender Verification API
  version: 1.0.0
extends: openapi/sendgrid-sender-verification-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: 8
- target: $.paths['/v3/verified_senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List verified and pending senders
      effect: read
      questions:
      - Which single senders on my account are verified and which are still pending?
      - Can I page through my verified senders using a last-seen ID?
      instructions:
      - text: List all my single senders with their verification status.
      - text: Show {limit} verified senders after ID {lastSeenID}.
        slots:
          limit: query.limit
          lastSeenID: query.lastSeenID
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/verified_senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Request verification of a new single sender
      effect: write
      questions:
      - How do I verify a from address so I can send without authenticating my whole domain?
      - What happens after I submit a new single sender, is a verification email sent?
      instructions:
      - text: Create single sender {nickname} sending from {from_email} with replies to {reply_to}.
        slots:
          nickname: requestBody.nickname
          from_email: requestBody.from_email
          reply_to: requestBody.reply_to
      - text: Start sender verification for {from_email} named {from_name}, nickname {nickname}, reply-to {reply_to}.
        slots:
          from_email: requestBody.from_email
          from_name: requestBody.from_name
          nickname: requestBody.nickname
          reply_to: requestBody.reply_to
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/verified_senders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single sender
      effect: destructive
      questions:
      - Can I remove a single sender I no longer use?
      - What ID do I need to delete a verified sender?
      instructions:
      - text: Delete single sender {id}.
        slots:
          id: path.id
      - text: Remove verified sender ID {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/verified_senders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a single sender's details
      effect: write
      questions:
      - Can I change the nickname or reply-to on a verified single sender?
      - Which fields must I still send when editing a single sender?
      instructions:
      - text: Update single sender {id} to reply-to {reply_to}, from {from_email}, nickname {nickname}.
        slots:
          id: path.id
          reply_to: requestBody.reply_to
          from_email: requestBody.from_email
          nickname: requestBody.nickname
      - text: Edit the physical address of single sender {id} to {address}, {city}.
        slots:
          id: path.id
          address: requestBody.address
          city: requestBody.city
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/verified_senders/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List DMARC-restricted sender domains
      effect: read
      questions:
      - Why won't mail deliver when I use a free webmail address as my sender?
      - Which email domains have DMARC policies that hard-fail or soft-fail as a sender?
      instructions:
      - text: Show the domain warn list of DMARC hard and soft failures.
      - text: List sender domains I should avoid because of their DMARC policy.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/verified_senders/resend/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a single sender verification email
      effect: write
      questions:
      - The verification email for my single sender expired, can I get a new one?
      - Can I resend the single sender verification link?
      instructions:
      - text: Resend the verification email for single sender {id}.
        slots:
          id: path.id
      - text: Send single sender {id} a fresh verification link.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/verified_senders/steps_completed'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which verification steps are done
      effect: read
      questions:
      - Have I completed domain authentication or single sender verification yet?
      - Is my account ready to send, verification-wise?
      instructions:
      - text: Tell me which sender verification steps my account has completed.
      - text: Check whether domain authentication and single sender verification are done.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/verified_senders/verify/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Confirm a sender with its verification token
      effect: read
      questions:
      - What do I do with the token from a sender verification email?
      - Can I complete single sender verification programmatically?
      instructions:
      - text: Verify the sender using token {token}.
        slots:
          token: path.token
      - text: Complete sender verification with the emailed token {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'