SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Marketing Campaigns Segments Segmenting…

4 actions 4 updates phrasing extends openapi/sendgrid-segmenting-contacts-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 4

$.info
$.paths['/v3/marketing/segments'].get
$.paths['/v3/marketing/segments/{segment_id}'].get
$.paths['/v3/marketing/segments/{segment_id}'].delete

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 Segments Segmenting…
  version: 1.0.0
extends: openapi/sendgrid-segmenting-contacts-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: 3
- target: $.paths['/v3/marketing/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact segments (original segmentation)
      effect: read
      questions:
      - Which segments exist under the original segmentation endpoints?
      - Can I list only segments with no parent list, using the older segments API?
      instructions:
      - text: List my segments using the original segmentation endpoint.
      - text: Show original-API segments with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/segments/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segment (original segmentation)
      effect: read
      questions:
      - Can I fetch a segment's query as JSON from the original segments endpoint?
      - What does a single segment look like in the pre-2.0 segmentation API?
      instructions:
      - text: Get segment {segment_id} from the original segmentation endpoint.
        slots:
          segment_id: path.segment_id
      - text: 'Fetch segment {segment_id} with its query as JSON: {query_json}.'
        slots:
          segment_id: path.segment_id
          query_json: query.query_json
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/segments/{segment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment but keep its contacts
      effect: destructive
      questions:
      - If I delete a segment, are its contacts deleted too?
      - How do I remove a segment through the original segmentation API?
      instructions:
      - text: Delete segment {segment_id} using the original segmentation endpoint.
        slots:
          segment_id: path.segment_id
      - text: Remove segment {segment_id} and leave its contacts in place.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-24'