Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io Track Track Segments API

3 actions 3 updates phrasing extends openapi/customer-io-track-segments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Customer.io's API. It is a proposal applied on top of the contract, not a document Customer.io publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v1/segments/{segment_id}/add_customers'].post
$.paths['/api/v1/segments/{segment_id}/remove_customers'].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 Customer.io Track Track Segments API
  version: 1.0.0
extends: openapi/customer-io-track-segments-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: 2
- target: $.paths['/api/v1/segments/{segment_id}/add_customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add people to a manual segment
      effect: write
      questions:
      - How do I add a list of people to a manual segment?
      - How many people can I add to a segment per request?
      instructions:
      - text: Add {ids} to segment {segment_id}.
        slots:
          ids: requestBody.ids
          segment_id: path.segment_id
      - text: Put people {ids} into manual segment {segment_id} by {id_type}.
        slots:
          ids: requestBody.ids
          segment_id: path.segment_id
          id_type: query.id_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/segments/{segment_id}/remove_customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove people from a manual segment
      effect: write
      questions:
      - How do I take people out of a manual segment?
      - Is there a limit on how many people I can remove from a segment at once?
      instructions:
      - text: Remove {ids} from segment {segment_id}.
        slots:
          ids: requestBody.ids
          segment_id: path.segment_id
      - text: Take people {ids} out of manual segment {segment_id} by {id_type}.
        slots:
          ids: requestBody.ids
          segment_id: path.segment_id
          id_type: query.id_type
      method: generated
      generated: '2026-09-26'