SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Marketing Campaigns Single Sends API

12 actions 12 updates phrasing extends openapi/sendgrid-single-sends-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 12

$.info
$.paths['/v3/marketing/singlesends'].get
$.paths['/v3/marketing/singlesends'].post
$.paths['/v3/marketing/singlesends'].delete
$.paths['/v3/marketing/singlesends/{id}'].get
$.paths['/v3/marketing/singlesends/{id}'].post
$.paths['/v3/marketing/singlesends/{id}'].delete
$.paths['/v3/marketing/singlesends/{id}'].patch
$.paths['/v3/marketing/singlesends/{id}/schedule'].put
$.paths['/v3/marketing/singlesends/{id}/schedule'].delete
$.paths['/v3/marketing/singlesends/categories'].get
$.paths['/v3/marketing/singlesends/search'].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 Single Sends API
  version: 1.0.0
extends: openapi/sendgrid-single-sends-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: 11
- target: $.paths['/v3/marketing/singlesends'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Single Sends
      effect: read
      questions:
      - What Single Sends have I created so far?
      - Can I page through all my Single Sends to collect their IDs?
      instructions:
      - text: List all my Single Sends.
      - text: Show my Single Sends, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Single Send
      effect: write
      questions:
      - How do I set up a new Single Send marketing email?
      - Can I choose the lists or segments a Single Send goes to when I create it?
      - Do I still need a template ID to create a Single Send?
      instructions:
      - text: Create a Single Send named {name}.
        slots:
          name: requestBody.name
      - text: Create Single Send {name} going to {send_to} at {send_at}.
        slots:
          name: requestBody.name
          send_to: requestBody.send_to
          send_at: requestBody.send_at
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete Single Sends
      effect: destructive
      questions:
      - Can I delete several Single Sends at once by ID?
      - Is deleting multiple Single Sends permanent?
      instructions:
      - text: Delete the Single Sends with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Bulk remove these Single Sends: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Single Send by ID
      effect: read
      questions:
      - What are the full details of one Single Send?
      - Where can I see the settings of a specific Single Send?
      instructions:
      - text: Get Single Send {id}.
        slots:
          id: path.id
      - text: Show me the full details of Single Send {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a Single Send
      effect: write
      questions:
      - Can I copy an existing Single Send instead of starting from scratch?
      - Is it possible to give a duplicated Single Send a new name?
      instructions:
      - text: Duplicate Single Send {id}.
        slots:
          id: path.id
      - text: Make a copy of Single Send {id} called {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Single Send
      effect: destructive
      questions:
      - How do I permanently delete one Single Send?
      - Is a deleted Single Send recoverable?
      instructions:
      - text: Delete Single Send {id}.
        slots:
          id: path.id
      - text: Permanently remove the Single Send with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a draft Single Send
      effect: write
      questions:
      - Can I edit a Single Send draft without sending it?
      - Which Single Send fields can I change, like categories or recipients?
      instructions:
      - text: Update Single Send {id} with the name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: 'Edit Single Send {id}: name {name}, categories {categories}.'
        slots:
          id: path.id
          name: requestBody.name
          categories: requestBody.categories
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/{id}/schedule'].put
  update:
    x-apievangelist-phrasing:
      intent: Send or schedule a Single Send
      effect: write
      questions:
      - Can I send a Single Send right now instead of scheduling it?
      - How do I schedule a Single Send for a future date and time?
      instructions:
      - text: Schedule Single Send {id} to go out at {send_at}.
        slots:
          id: path.id
          send_at: requestBody.send_at
      - text: Send Single Send {id} now by setting send time to {send_at}.
        slots:
          id: path.id
          send_at: requestBody.send_at
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/{id}/schedule'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a Single Send's schedule
      effect: destructive
      questions:
      - Can I cancel a scheduled Single Send without deleting it?
      - What happens to the Single Send itself when I remove its schedule?
      instructions:
      - text: Cancel the scheduled delivery of Single Send {id}.
        slots:
          id: path.id
      - text: Unschedule Single Send {id} but keep the draft.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List Single Send categories
      effect: read
      questions:
      - Which categories have I used on my Single Sends?
      - How many Single Send categories does the category list return?
      instructions:
      - text: List all categories used on my Single Sends.
      - text: Show the latest categories attached to Single Sends.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/singlesends/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Single Sends by name, status or category
      effect: read
      questions:
      - Can I find Single Sends that are still drafts or already scheduled?
      - Is there a way to search Single Sends by name or category?
      instructions:
      - text: Search my Single Sends for the name {name}.
        slots:
          name: requestBody.name
      - text: Find Single Sends with status {status} in categories {categories}.
        slots:
          status: requestBody.status
          categories: requestBody.categories
      method: generated
      generated: '2026-09-24'