Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Messages API

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

$.info

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

$.paths['/v1/messages/{message_id}'].get

$.paths['/v1/messages/{message_id}/archived_message'].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 Messages API
  version: 1.0.0
extends: openapi/customer-io-messages-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: 3
- target: $.paths['/v1/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List message deliveries in the workspace
      effect: read
      questions:
      - How do I see all the messages my workspace sent yesterday?
      - Can I filter workspace deliveries by campaign, newsletter or action?
      - Which messages bounced across the whole workspace?
      instructions:
      - text: List workspace deliveries with metric {metric}.
        slots:
          metric: query.metric
      - text: Show deliveries for campaign {campaign_id} across the workspace.
        slots:
          campaign_id: query.campaign_id
      - text: List all {type} deliveries sent between {start_ts} and {end_ts}.
        slots:
          type: query.type
          start_ts: query.start_ts
          end_ts: query.end_ts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/messages/{message_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a delivery and its metrics
      effect: read
      questions:
      - Was a specific message delivered and opened?
      - How do I see the metrics for one delivery?
      instructions:
      - text: Get delivery {message_id}.
        slots:
          message_id: path.message_id
      - text: Show metrics for message {message_id}.
        slots:
          message_id: path.message_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/messages/{message_id}/archived_message'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the archived copy of a message
      effect: read
      questions:
      - How do I see exactly what content a person received in a message?
      - Is there a daily limit on fetching archived messages?
      instructions:
      - text: Get the archived copy of message {message_id}.
        slots:
          message_id: path.message_id
      - text: Show me the body that was sent in delivery {message_id}.
        slots:
          message_id: path.message_id
      method: generated
      generated: '2026-09-26'