Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Snippets API

5 actions 5 updates phrasing extends openapi/customer-io-snippets-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/snippets'].get
$.paths['/v1/snippets'].put
$.paths['/v1/snippets'].post
$.paths['/v1/snippets/{snippet_name}'].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 Snippets API
  version: 1.0.0
extends: openapi/customer-io-snippets-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/snippets'].get
  update:
    x-apievangelist-phrasing:
      intent: List snippets
      effect: read
      questions:
      - What reusable snippets, like footers, do I have?
      - How do I see the value of every snippet?
      instructions:
      - text: List my snippets.
      - text: Show all reusable content snippets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/snippets'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a snippet by name
      effect: write
      questions:
      - How do I change the value of an existing snippet?
      - Can I upsert a snippet so it's created if missing?
      instructions:
      - text: Set snippet {name} to {value}, creating it if needed.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Upsert the {name} snippet with {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/snippets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new snippet
      effect: write
      questions:
      - How do I add a new reusable footer snippet?
      - What happens if I create a snippet with a name that already exists?
      instructions:
      - text: Create a new snippet {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Add snippet {name} containing {value}, failing if it exists.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/snippets/{snippet_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a snippet
      effect: destructive
      questions:
      - How do I delete a snippet?
      - Why can't I delete a snippet that's in use?
      instructions:
      - text: Delete snippet {snippet_name}.
        slots:
          snippet_name: path.snippet_name
      - text: Remove the {snippet_name} snippet.
        slots:
          snippet_name: path.snippet_name
      method: generated
      generated: '2026-09-26'