Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Sender Identities API

4 actions 4 updates phrasing extends openapi/customer-io-sender-identities-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/sender_identities'].get
$.paths['/v1/sender_identities/{sender_id}'].get
$.paths['/v1/sender_identities/{sender_id}/used_by'].get

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 Sender Identities API
  version: 1.0.0
extends: openapi/customer-io-sender-identities-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/sender_identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List sender identities
      effect: read
      questions:
      - Which from addresses are set up in my workspace?
      - Can I include hidden senders in the list?
      instructions:
      - text: List my sender identities.
      - text: 'Show senders including hidden ones: {hidden}.'
        slots:
          hidden: query.hidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/sender_identities/{sender_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sender identity
      effect: read
      questions:
      - How do I see the name and email of one sender?
      - What address does a particular sender identity send from?
      instructions:
      - text: Get sender {sender_id}.
        slots:
          sender_id: path.sender_id
      - text: Show details of sender identity {sender_id}.
        slots:
          sender_id: path.sender_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/sender_identities/{sender_id}/used_by'].get
  update:
    x-apievangelist-phrasing:
      intent: See which campaigns use a sender
      effect: read
      questions:
      - Which campaigns and newsletters send from a given sender?
      - Is a sender identity still in use anywhere?
      instructions:
      - text: Show what uses sender {sender_id}.
        slots:
          sender_id: path.sender_id
      - text: List campaigns and newsletters sending as {sender_id}.
        slots:
          sender_id: path.sender_id
      method: generated
      generated: '2026-09-26'