SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Legacy Marketing Campaigns Sender…

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

$.info
$.paths['/v3/senders'].get
$.paths['/v3/senders'].post
$.paths['/v3/senders/{sender_id}'].get
$.paths['/v3/senders/{sender_id}'].delete
$.paths['/v3/senders/{sender_id}'].patch
$.paths['/v3/senders/{sender_id}/resend_verification'].post

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 Legacy Marketing Campaigns Sender…
  version: 1.0.0
extends: openapi/sendgrid-sender-identities-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: 6
- target: $.paths['/v3/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List sender identities
      effect: read
      questions:
      - Which sender identities have been created on my account?
      - Can I see all my from addresses set up as sender identities?
      instructions:
      - text: List all of my sender identities.
      - text: Show every sender identity on the account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sender identity
      effect: write
      questions:
      - How many sender identities am I allowed to create?
      - What address details are required for a new sender identity?
      instructions:
      - text: Create sender identity {nickname} at {address}, {city}, {country}.
        slots:
          nickname: requestBody.nickname
          address: requestBody.address
          city: requestBody.city
          country: requestBody.country
      - text: Add a sender identity {nickname} sending from {from} with reply-to {reply_to}, located at {address}, {city}, {country}.
        slots:
          nickname: requestBody.nickname
          from: requestBody.from
          reply_to: requestBody.reply_to
          address: requestBody.address
          city: requestBody.city
          country: requestBody.country
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/senders/{sender_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a sender identity
      effect: read
      questions:
      - What from name, reply-to and address does one sender identity use?
      - Is a particular sender identity verified?
      instructions:
      - text: Show sender identity {sender_id}.
        slots:
          sender_id: path.sender_id
      - text: Get the details and verification state of sender {sender_id}.
        slots:
          sender_id: path.sender_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/senders/{sender_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sender identity
      effect: destructive
      questions:
      - Can I remove a sender identity I no longer need?
      - How do I delete one of my sender identities?
      instructions:
      - text: Delete sender identity {sender_id}.
        slots:
          sender_id: path.sender_id
      - text: Remove sender {sender_id} from my account.
        slots:
          sender_id: path.sender_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/senders/{sender_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a sender identity
      effect: write
      questions:
      - Does changing the from email on a sender identity require re-verification?
      - Can I partially update a sender identity's address?
      instructions:
      - text: Change the from address on sender identity {sender_id} to {from}.
        slots:
          sender_id: path.sender_id
          from: requestBody.from
      - text: Rename sender identity {sender_id} to {nickname}.
        slots:
          sender_id: path.sender_id
          nickname: requestBody.nickname
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/senders/{sender_id}/resend_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a sender identity verification email
      effect: write
      questions:
      - My sender identity never got verified, can I get the verification email again?
      - Is there a way to re-trigger sender identity verification?
      instructions:
      - text: Resend the verification email for sender identity {sender_id}.
        slots:
          sender_id: path.sender_id
      - text: Re-send verification to sender {sender_id}.
        slots:
          sender_id: path.sender_id
      method: generated
      generated: '2026-09-24'