Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Opt Outs API

4 actions 4 updates phrasing extends openapi/customer-io-opt-outs-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/optouts'].get
$.paths['/v1/customers/{customer_id}/optouts'].get
$.paths['/v1/customers/{customer_id}/optouts'].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 Opt Outs API
  version: 1.0.0
extends: openapi/customer-io-opt-outs-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/optouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List opt-outs across the workspace
      effect: read
      questions:
      - Who has opted out of SMS or WhatsApp messages in my workspace?
      - Can I list opt-outs since a certain date?
      instructions:
      - text: List all workspace opt-outs.
      - text: Show opt-outs recorded since {from}.
        slots:
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer_id}/optouts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a person's opt-outs
      effect: read
      questions:
      - Which senders and channels has a person opted out of?
      - Has this person unsubscribed from SMS?
      instructions:
      - text: Show the opt-outs for person {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: List senders {customer_id} opted out of.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer_id}/optouts'].put
  update:
    x-apievangelist-phrasing:
      intent: Opt a person out of or back into senders
      effect: write
      questions:
      - How do I opt someone out of WhatsApp messages from one sender?
      - Can I opt a person back in to SMS after they opted out?
      instructions:
      - text: Update opt-outs for person {customer_id} to {optouts}.
        slots:
          customer_id: path.customer_id
          optouts: requestBody.optouts
      - text: Opt {customer_id} back in using {optouts}.
        slots:
          customer_id: path.customer_id
          optouts: requestBody.optouts
      method: generated
      generated: '2026-09-26'