Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Collections API

8 actions 8 updates phrasing extends openapi/customer-io-collections-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/collections'].get
$.paths['/v1/collections'].post
$.paths['/v1/collections/{collection_id}'].get
$.paths['/v1/collections/{collection_id}'].put
$.paths['/v1/collections/{collection_id}'].delete
$.paths['/v1/collections/{collection_id}/content'].get
$.paths['/v1/collections/{collection_id}/content'].put

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 App Collections API
  version: 1.0.0
extends: openapi/customer-io-collections-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/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List collections
      effect: read
      questions:
      - What data collections do I have for use in messages?
      - How do I see the schema of all my collections?
      instructions:
      - text: List all my collections.
      - text: Show every collection with its name and schema.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a collection
      effect: write
      questions:
      - How do I upload a lookup table of data I can reference in messages?
      - Can I create a collection from a CSV or JSON file at a URL?
      instructions:
      - text: Create a new collection from this data.
      - text: Create a collection that downloads its rows from a URL.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collection_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a collection
      effect: read
      questions:
      - How do I look up one collection's name and schema?
      - Does looking up a collection return its rows?
      instructions:
      - text: Get collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Show the schema of collection {collection_id}.
        slots:
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collection_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or replace a collection
      effect: write
      questions:
      - Can I rename a collection?
      - How do I point a collection at a new data URL?
      instructions:
      - text: Rename collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Replace collection {collection_id} with data from a new URL.
        slots:
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collection_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a collection
      effect: destructive
      questions:
      - How do I remove a collection I no longer use?
      - What happens to messages that still reference a deleted collection?
      instructions:
      - text: Delete collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Remove collection {collection_id} and all of its contents.
        slots:
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collection_id}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the rows in a collection
      effect: read
      questions:
      - How do I read the actual data rows stored in a collection?
      - Can I download a collection's contents as JSON?
      instructions:
      - text: Get the contents of collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Show me every row in collection {collection_id}.
        slots:
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collection_id}/content'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the rows in a collection
      effect: write
      questions:
      - How do I overwrite a collection's data without changing its name?
      - Can I push new rows into an existing collection?
      instructions:
      - text: Replace the contents of collection {collection_id} with these rows.
        slots:
          collection_id: path.collection_id
      - text: Overwrite the data rows in collection {collection_id}.
        slots:
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'