Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Email Contacts API

5 actions 5 updates phrasing extends openapi/twilio-contacts-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 5

$.info
$.paths['/marketing/contacts'].get
$.paths['/marketing/contacts'].put
$.paths['/marketing/contacts'].delete
$.paths['/marketing/contacts/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 Email Contacts API
  version: 1.0.0
extends: openapi/twilio-contacts-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: 4
- target: $.paths['/marketing/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List marketing contacts
      effect: read
      questions:
      - Who is in my marketing contacts database?
      - Can I page through all of my marketing contacts?
      instructions:
      - text: List my marketing contacts.
      - text: Show me the first page of marketing contacts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketing/contacts'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or update marketing contacts
      effect: write
      questions:
      - How are existing contacts matched when I upload a batch of contacts?
      - Can I add new contacts straight onto specific marketing lists?
      instructions:
      - text: 'Add or update these contacts: {contacts}.'
        slots:
          contacts: requestBody.contacts
      - text: Upsert {contacts} and add them to lists {list_ids}.
        slots:
          contacts: requestBody.contacts
          list_ids: requestBody.list_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketing/contacts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete marketing contacts
      effect: destructive
      questions:
      - Can I remove several marketing contacts at once by ID?
      - What permanently deletes contacts from my marketing database?
      instructions:
      - text: Delete contacts {ids}.
        slots:
          ids: query.ids
      - text: Remove the marketing contacts with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketing/contacts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search marketing contacts with a query
      effect: write
      questions:
      - Can I find contacts matching conditions like a domain or a signup date?
      - What query language does the contact search accept?
      instructions:
      - text: Search my contacts with the SGQL query {query}.
        slots:
          query: requestBody.query
      - text: Find contacts matching {query}.
        slots:
          query: requestBody.query
      method: generated
      generated: '2026-09-26'