Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Exports API

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

$.info

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

$.paths['/v1/exports/{export_id}'].get

$.paths['/v1/exports/{export_id}/download'].get

$.paths['/v1/exports/customers'].post

$.paths['/v1/exports/deliveries'].post

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 Exports API
  version: 1.0.0
extends: openapi/customer-io-exports-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: 5
- target: $.paths['/v1/exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List exports
      effect: read
      questions:
      - What data exports have I run?
      - How do I find the ID of an export I started earlier?
      instructions:
      - text: List my exports.
      - text: Show all people and delivery exports in this workspace.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exports/{export_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an export's status
      effect: read
      questions:
      - Is my export finished yet?
      - How do I see the details of a specific export?
      instructions:
      - text: Get export {export_id}.
        slots:
          export_id: path.export_id
      - text: Check whether export {export_id} is done.
        slots:
          export_id: path.export_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exports/{export_id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download link for an export
      effect: read
      questions:
      - How do I download the file from a finished export?
      - How long is an export download link valid?
      instructions:
      - text: Get the download link for export {export_id}.
        slots:
          export_id: path.export_id
      - text: Download export {export_id}.
        slots:
          export_id: path.export_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exports/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Export people matching filters
      effect: write
      questions:
      - How do I export a CSV of people who match certain filters?
      - Can I choose which attributes to include in a people export?
      instructions:
      - text: Export people matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Start a people export for {filters} with attributes {attributes}.
        slots:
          filters: requestBody.filters
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exports/deliveries'].post
  update:
    x-apievangelist-phrasing:
      intent: Export delivery data for messages
      effect: write
      questions:
      - How do I export delivery records for a newsletter or campaign?
      - Can I bulk export who received a particular message action?
      instructions:
      - text: Start an export of deliveries for a campaign.
      - text: Export the delivery data from a newsletter.
      method: generated
      generated: '2026-09-26'