Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Segments API

8 actions 8 updates phrasing extends openapi/customer-io-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 8

$.info

$.paths['/v1/segments'].get

$.paths['/v1/segments'].post

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

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

$.paths['/v1/segments/{segment_id}/used_by'].get

$.paths['/v1/segments/{segment_id}/customer_count'].get

$.paths['/v1/segments/{segment_id}/membership'].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 Customer.io App Segments API
  version: 1.0.0
extends: openapi/customer-io-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: 7
- target: $.paths['/v1/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments
      effect: read
      questions:
      - What segments do I have in my workspace?
      - How do I find a segment's ID?
      instructions:
      - text: List all my segments.
      - text: Show every segment with its type.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a manual segment
      effect: write
      questions:
      - How do I create an empty manual segment through the API?
      - Can I give a new manual segment a description?
      instructions:
      - text: Create a manual segment {segment}.
        slots:
          segment: requestBody.segment
      - text: Make a new empty manual segment with name and description {segment}.
        slots:
          segment: requestBody.segment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/segments/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segment
      effect: read
      questions:
      - How do I look up one segment's details?
      - Is a given segment manual or data-driven?
      instructions:
      - text: Get segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Show details of segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/segments/{segment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a manual segment
      effect: destructive
      questions:
      - How do I delete a manual segment?
      - Can I remove a segment I created by hand?
      instructions:
      - text: Delete segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Remove manual segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/segments/{segment_id}/used_by'].get
  update:
    x-apievangelist-phrasing:
      intent: See which campaigns use a segment
      effect: read
      questions:
      - Which campaigns and newsletters use this segment?
      - Is it safe to delete a segment, is anything depending on it?
      instructions:
      - text: Show what uses segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: List campaigns and newsletters that reference segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/segments/{segment_id}/customer_count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count people in a segment
      effect: read
      questions:
      - How many people are in a segment right now?
      - What's the member count of my VIP segment?
      instructions:
      - text: Count the people in segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Get the membership count for segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/segments/{segment_id}/membership'].get
  update:
    x-apievangelist-phrasing:
      intent: List people in a segment
      effect: read
      questions:
      - Who exactly is in a given segment?
      - How do I page through a segment's members?
      instructions:
      - text: List the people in segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Show the first {limit} members of segment {segment_id}.
        slots:
          limit: query.limit
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'