Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Newsletters API

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

$.info
$.paths['/v1/newsletters'].get
$.paths['/v1/newsletters'].post
$.paths['/v1/newsletters/{newsletter_id}'].get
$.paths['/v1/newsletters/{newsletter_id}'].delete

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 Newsletters API
  version: 1.0.0
extends: openapi/customer-io-newsletters-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: 4
- target: $.paths['/v1/newsletters'].get
  update:
    x-apievangelist-phrasing:
      intent: List newsletters
      effect: read
      questions:
      - What newsletters have I created?
      - Can I list my newsletters newest first?
      instructions:
      - text: List my newsletters.
      - text: Show the {limit} most recent newsletters sorted {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and send or schedule a newsletter
      effect: write
      questions:
      - How do I create a newsletter and send it right away through the API?
      - Can I create a newsletter and schedule it for later in one call?
      instructions:
      - text: Create a newsletter and send it now.
      - text: Create a new newsletter and schedule it for next Monday.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a newsletter
      effect: read
      questions:
      - How do I look up one newsletter's settings and status?
      - Was a particular newsletter already sent?
      instructions:
      - text: Get newsletter {newsletter_id}.
        slots:
          newsletter_id: path.newsletter_id
      - text: Show metadata for newsletter {newsletter_id}.
        slots:
          newsletter_id: path.newsletter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a newsletter
      effect: destructive
      questions:
      - How do I delete a newsletter I don't need anymore?
      - Does deleting a newsletter remove its metrics too?
      instructions:
      - text: Delete newsletter {newsletter_id}.
        slots:
          newsletter_id: path.newsletter_id
      - text: Remove newsletter {newsletter_id} with its content and metrics.
        slots:
          newsletter_id: path.newsletter_id
      method: generated
      generated: '2026-09-26'