SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Marketing Campaigns Senders API

7 actions 7 updates phrasing extends openapi/sendgrid-senders-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/marketing/senders'].get
$.paths['/v3/marketing/senders'].post
$.paths['/v3/marketing/senders/{id}'].get
$.paths['/v3/marketing/senders/{id}'].delete
$.paths['/v3/marketing/senders/{id}'].patch
$.paths['/v3/marketing/senders/{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 Marketing Campaigns Senders API
  version: 1.0.0
extends: openapi/sendgrid-senders-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/marketing/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List all marketing Senders
      effect: read
      questions:
      - Which Sender identities have I set up for Marketing Campaigns?
      - Can I see all my Senders and whether they're verified?
      instructions:
      - text: List all my marketing Senders.
      - text: Show every Sender identity on the account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a marketing Sender
      effect: write
      questions:
      - How many unique Senders can I create?
      - Does a new Sender verify automatically if my domain is authenticated?
      - What address details are required to create a Sender?
      instructions:
      - text: Create a Sender nicknamed {nickname} sending from {from}, reply-to {reply_to}, 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
      - text: Add Sender {nickname} with from {from} and reply-to {reply_to}, mailing address {address}, {city}, {state} {zip}, {country}.
        slots:
          nickname: requestBody.nickname
          from: requestBody.from
          reply_to: requestBody.reply_to
          address: requestBody.address
          city: requestBody.city
          state: requestBody.state
          zip: requestBody.zip
          country: requestBody.country
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/senders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Sender by ID
      effect: read
      questions:
      - What are the from address and mailing details of one Sender?
      - Is a specific Sender verified yet?
      instructions:
      - text: Get Sender {id}.
        slots:
          id: path.id
      - text: Show the details of Sender identity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/senders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Sender
      effect: destructive
      questions:
      - Can I delete a Sender identity I no longer use?
      - Which call removes an existing marketing Sender?
      instructions:
      - text: Delete Sender {id}.
        slots:
          id: path.id
      - text: Remove Sender identity {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/senders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Sender
      effect: write
      questions:
      - If I change a Sender's from email, will it need to be verified again?
      - Can I update just the nickname or reply-to on an existing Sender?
      instructions:
      - text: Change the nickname of Sender {id} to {nickname}.
        slots:
          id: path.id
          nickname: requestBody.nickname
      - text: Update Sender {id} to use reply-to {reply_to}.
        slots:
          id: path.id
          reply_to: requestBody.reply_to
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/senders/{id}/resend_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a Sender verification email
      effect: write
      questions:
      - My Sender verification email never arrived; can it be sent again?
      - How do I re-trigger verification for a Sender?
      instructions:
      - text: Resend the verification email for Sender {id}.
        slots:
          id: path.id
      - text: Send Sender {id} its verification request again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'