SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Marketing Campaigns Designs API

10 actions 10 updates phrasing extends openapi/sendgrid-designs-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 10

$.info
$.paths['/v3/designs'].get
$.paths['/v3/designs'].post
$.paths['/v3/designs/{id}'].get
$.paths['/v3/designs/{id}'].post
$.paths['/v3/designs/{id}'].delete
$.paths['/v3/designs/{id}'].patch
$.paths['/v3/designs/pre-builts'].get
$.paths['/v3/designs/pre-builts/{id}'].get
$.paths['/v3/designs/pre-builts/{id}'].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 Designs API
  version: 1.0.0
extends: openapi/sendgrid-designs-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: 9
- target: $.paths['/v3/designs'].get
  update:
    x-apievangelist-phrasing:
      intent: List designs in my Design Library
      effect: read
      questions:
      - What email designs have I saved in my Design Library?
      - Does listing my designs include the pre-built ones?
      instructions:
      - text: List the designs in my Design Library.
      - text: Show {page_size} of my saved designs per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email design
      effect: write
      questions:
      - How do I add a new email design from my own HTML?
      - Can I include a plain-text version when I create a design?
      instructions:
      - text: 'Create a design from this HTML: {html_content}.'
        slots:
          html_content: requestBody.html_content
      - text: Save a new design named {name} with HTML {html_content}.
        slots:
          name: requestBody.name
          html_content: requestBody.html_content
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my designs
      effect: read
      questions:
      - Where can I see the stored HTML and subject of one of my designs?
      - What details come back for a single design in my library?
      instructions:
      - text: Get my design {id}.
        slots:
          id: path.id
      - text: Show the content of saved design {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate one of my designs
      effect: write
      questions:
      - Can I copy one of my own designs to start a new one?
      - What name does a duplicated design get if I leave it blank?
      instructions:
      - text: Duplicate my design {id}.
        slots:
          id: path.id
      - text: Copy my saved design {id} as {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a design
      effect: destructive
      questions:
      - Is deleting a design from my library permanent?
      - How do I remove a design I no longer need?
      instructions:
      - text: Delete design {id}.
        slots:
          id: path.id
      - text: Permanently remove design {id} from my library.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a design
      effect: write
      questions:
      - Can I change just the subject of a design without touching its HTML?
      - Which fields on a saved design can I partially update?
      instructions:
      - text: Change the subject of design {id} to {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      - text: Replace the HTML of design {id} with {html_content}.
        slots:
          id: path.id
          html_content: requestBody.html_content
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs/pre-builts'].get
  update:
    x-apievangelist-phrasing:
      intent: List SendGrid pre-built designs
      effect: read
      questions:
      - Which ready-made email designs does SendGrid provide?
      - Can I browse the pre-built design templates page by page?
      instructions:
      - text: List the pre-built designs.
      - text: Show {page_size} ready-made pre-built designs per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs/pre-builts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pre-built design
      effect: read
      questions:
      - What does a specific pre-built design contain before I copy it?
      - Can I look up one ready-made design by its ID?
      instructions:
      - text: Get pre-built design {id}.
        slots:
          id: path.id
      - text: Show the details of ready-made design {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/designs/pre-builts/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a pre-built design into my library
      effect: write
      questions:
      - How do I copy a pre-built design into my own Design Library?
      - Can I choose the editor type when I duplicate a pre-built design?
      instructions:
      - text: Duplicate pre-built design {id} into my library.
        slots:
          id: path.id
      - text: Copy ready-made design {id} as {name} using the {editor} editor.
        slots:
          id: path.id
          name: requestBody.name
          editor: requestBody.editor
      method: generated
      generated: '2026-09-24'