Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App ESP Suppression API

6 actions 6 updates phrasing extends openapi/customer-io-esp-suppression-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/esp/search_suppression/{email_address}'].get

$.paths['/v1/esp/suppression/{suppression_type}'].get

$.paths['/v1/esp/domains/{domain_name}/suppression/{suppression_type}'].get

$.paths['/v1/esp/suppression/{suppression_type}/{email_address}'].post

$.paths['/v1/esp/suppression/{suppression_type}/{email_address}'].delete

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 ESP Suppression API
  version: 1.0.0
extends: openapi/customer-io-esp-suppression-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/esp/search_suppression/{email_address}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an email is ESP-suppressed
      effect: read
      questions:
      - Why isn't a particular address receiving our emails, is it suppressed?
      - How do I find out why the email provider suppressed an address?
      instructions:
      - text: Check whether {email_address} is suppressed at the ESP.
        slots:
          email_address: path.email_address
      - text: Look up the ESP suppression reason for {email_address}.
        slots:
          email_address: path.email_address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/esp/suppression/{suppression_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List ESP-suppressed emails by reason
      effect: read
      questions:
      - Which addresses have bounced or reported us as spam?
      - Can I list ESP-suppressed addresses for one email domain?
      instructions:
      - text: List addresses suppressed for {suppression_type}.
        slots:
          suppression_type: path.suppression_type
      - text: Show {suppression_type} suppressions for the {domain} domain.
        slots:
          suppression_type: path.suppression_type
          domain: query.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/esp/domains/{domain_name}/suppression/{suppression_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List ESP suppressions for a sending domain
      effect: read
      questions:
      - Which addresses were suppressed on one of my sending domains?
      - Can I check if a specific email is suppressed on a particular sending domain?
      instructions:
      - text: List {suppression_type} suppressions on sending domain {domain_name}.
        slots:
          suppression_type: path.suppression_type
          domain_name: path.domain_name
      - text: Check if {email} is suppressed for {suppression_type} on sending domain {domain_name}.
        slots:
          email: query.email
          suppression_type: path.suppression_type
          domain_name: path.domain_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/esp/suppression/{suppression_type}/{email_address}'].post
  update:
    x-apievangelist-phrasing:
      intent: Suppress an email address at the ESP
      effect: write
      questions:
      - How do I stop the email provider from sending to a specific address?
      - Does suppressing an address at the ESP also suppress the person in my workspace?
      instructions:
      - text: Suppress {email_address} at the ESP as {suppression_type}.
        slots:
          email_address: path.email_address
          suppression_type: path.suppression_type
      - text: Add {email_address} to the ESP {suppression_type} list.
        slots:
          email_address: path.email_address
          suppression_type: path.suppression_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/esp/suppression/{suppression_type}/{email_address}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an address from ESP suppression
      effect: destructive
      questions:
      - How do I un-suppress an email address that bounced?
      - Can I take an address off the ESP's spam report list?
      instructions:
      - text: Un-suppress {email_address} from the {suppression_type} list.
        slots:
          email_address: path.email_address
          suppression_type: path.suppression_type
      - text: Remove the {suppression_type} ESP suppression for {email_address}.
        slots:
          suppression_type: path.suppression_type
          email_address: path.email_address
      method: generated
      generated: '2026-09-26'