SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Legacy Marketing Campaigns Contacts…

7 actions 7 updates phrasing extends openapi/sendgrid-segments-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/contactdb/segments'].get

$.paths['/v3/contactdb/segments'].post

$.paths['/v3/contactdb/segments/{segment_id}'].get

$.paths['/v3/contactdb/segments/{segment_id}'].delete

$.paths['/v3/contactdb/segments/{segment_id}'].patch

$.paths['/v3/contactdb/segments/{segment_id}/recipients'].get

OpenAPI Overlay

# 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 Legacy Marketing Campaigns Contacts…
  version: 1.0.0
extends: openapi/sendgrid-segments-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/contactdb/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List legacy contactdb segments
      effect: read
      questions:
      - What segments do I have in the legacy contacts database?
      - Can I see all my old recipient segments at once?
      instructions:
      - text: List all my legacy contactdb segments.
      - text: Show every recipient segment in the legacy database.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/contactdb/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a legacy segment from conditions
      effect: write
      questions:
      - How do I build a segment of recipients who match certain field conditions?
      - Which operators can I use for date fields in segment conditions?
      - Can a segment be limited to recipients on one list?
      instructions:
      - text: Create a segment named {name} with conditions {conditions}.
        slots:
          name: requestBody.name
          conditions: requestBody.conditions
      - text: Create segment {name} from list {list_id} using conditions {conditions}.
        slots:
          name: requestBody.name
          list_id: requestBody.list_id
          conditions: requestBody.conditions
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/contactdb/segments/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a legacy segment
      effect: read
      questions:
      - What conditions define a particular segment?
      - Can I look up one legacy segment by ID?
      instructions:
      - text: Get segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Show the conditions of legacy segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/contactdb/segments/{segment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a legacy segment
      effect: destructive
      questions:
      - When I delete a segment, can I also delete the contacts in it?
      - How do I remove a segment from the recipients database?
      instructions:
      - text: Delete segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: 'Delete segment {segment_id} and its contacts too: {delete_contacts}.'
        slots:
          segment_id: path.segment_id
          delete_contacts: query.delete_contacts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/contactdb/segments/{segment_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a legacy segment
      effect: write
      questions:
      - Can I change the conditions of an existing segment?
      - Is it possible to rename a legacy segment?
      instructions:
      - text: Rename segment {segment_id} to {name}.
        slots:
          segment_id: path.segment_id
          name: requestBody.name
      - text: Update segment {segment_id} named {name} with new conditions {conditions}.
        slots:
          segment_id: path.segment_id
          name: requestBody.name
          conditions: requestBody.conditions
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/contactdb/segments/{segment_id}/recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: List recipients in a legacy segment
      effect: read
      questions:
      - Which recipients currently match a given segment?
      - Can I page through the people in a segment?
      instructions:
      - text: List the recipients in segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Get page {page} of segment {segment_id}'s recipients, {page_size} per page.
        slots:
          page: query.page
          segment_id: path.segment_id
          page_size: query.page_size
      method: generated
      generated: '2026-09-24'