Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Email Lists API

6 actions 6 updates phrasing extends openapi/twilio-lists-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/marketing/lists'].get
$.paths['/marketing/lists'].post
$.paths['/marketing/lists/{list_id}'].get
$.paths['/marketing/lists/{list_id}'].delete
$.paths['/marketing/lists/{list_id}'].patch

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 Email Lists API
  version: 1.0.0
extends: openapi/twilio-lists-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/marketing/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List my marketing contact lists
      effect: read
      questions:
      - Which marketing contact lists do I have?
      - What email lists exist in my marketing account?
      instructions:
      - text: List all my marketing contact lists.
      - text: Show my contact lists, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketing/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a marketing contact list
      effect: write
      questions:
      - How do I start a new contact list for a marketing campaign?
      - Can I make an empty list to add contacts to later?
      instructions:
      - text: Create a contact list called {name}.
        slots:
          name: requestBody.name
      - text: Make a new marketing list named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketing/lists/{list_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one marketing contact list
      effect: read
      questions:
      - Can I see the details of a single contact list?
      - What are the details of one particular marketing list?
      instructions:
      - text: Get contact list {list}.
        slots:
          list: path.list_id
      - text: Show the details of marketing list {list}.
        slots:
          list: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketing/lists/{list_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a marketing contact list
      effect: destructive
      questions:
      - How do I delete a contact list I no longer need?
      - Can I delete the contacts in a list along with the list itself?
      instructions:
      - text: Delete contact list {list}.
        slots:
          list: path.list_id
      - text: Delete marketing list {list} and set delete-contacts to {delete_contacts}.
        slots:
          list: path.list_id
          delete_contacts: query.delete_contacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketing/lists/{list_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a marketing contact list
      effect: write
      questions:
      - Is there a way to rename an existing contact list?
      - Can I change a marketing list's name without losing its contacts?
      instructions:
      - text: Rename contact list {list} to {name}.
        slots:
          list: path.list_id
          name: requestBody.name
      - text: Change the name of marketing list {list} to {name}.
        slots:
          list: path.list_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'