Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Send Messages API

9 actions 9 updates phrasing extends openapi/customer-io-send-messages-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 9

$.info
$.paths['/v1/campaigns/{broadcast_id}/triggers'].post
$.paths['/v1/newsletters/{newsletter_id}/send'].post
$.paths['/v1/newsletters/{newsletter_id}/schedule'].post
$.paths['/v1/send/email'].post
$.paths['/v1/send/in_app'].post
$.paths['/v1/send/inbox_message'].post
$.paths['/v1/send/push'].post
$.paths['/v1/send/sms'].post

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 Send Messages API
  version: 1.0.0
extends: openapi/customer-io-send-messages-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: 8
- target: $.paths['/v1/campaigns/{broadcast_id}/triggers'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an API-triggered broadcast
      effect: write
      questions:
      - How do I kick off an API-triggered broadcast with custom data?
      - Can I pass liquid data into a broadcast when I trigger it?
      instructions:
      - text: Trigger broadcast {broadcast_id}.
        slots:
          broadcast_id: path.broadcast_id
      - text: Send broadcast {broadcast_id} now with this trigger data.
        slots:
          broadcast_id: path.broadcast_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a draft newsletter now
      effect: write
      questions:
      - How do I send a draft newsletter immediately?
      - Can I rate-limit how fast a newsletter goes out?
      instructions:
      - text: Send newsletter {newsletter_id} now.
        slots:
          newsletter_id: path.newsletter_id
      - text: Send newsletter {newsletter_id} at {rate_limit_email_rate} emails per {rate_limit_time_period}.
        slots:
          newsletter_id: path.newsletter_id
          rate_limit_email_rate: requestBody.rate_limit_email_rate
          rate_limit_time_period: requestBody.rate_limit_time_period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a draft newsletter
      effect: write
      questions:
      - How do I schedule a newsletter to go out at a specific time?
      - Can a scheduled newsletter send in each recipient's own timezone?
      instructions:
      - text: Schedule newsletter {newsletter_id} for {scheduled_at}.
        slots:
          newsletter_id: path.newsletter_id
          scheduled_at: requestBody.scheduled_at
      - text: Schedule newsletter {newsletter_id} at {scheduled_at} in timezone {timezone}.
        slots:
          newsletter_id: path.newsletter_id
          scheduled_at: requestBody.scheduled_at
          timezone: requestBody.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/send/email'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email
      effect: write
      questions:
      - How do I send a password reset email to one person?
      - Can I attach files or CC someone on a transactional email?
      - Can I schedule a transactional email to send later?
      instructions:
      - text: Send transactional email {transactional_message_id} to {to}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          to: requestBody.to
      - text: Email {to} with subject {subject} and body {body}.
        slots:
          to: requestBody.to
          subject: requestBody.subject
          body: requestBody.body
      - text: Send transactional email {transactional_message_id} to {identifiers} with data {message_data}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          identifiers: requestBody.identifiers
          message_data: requestBody.message_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/send/in_app'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional in-app message
      effect: write
      questions:
      - How do I show a one-off in-app message to a specific user?
      - Can I personalize a transactional in-app message with data?
      instructions:
      - text: Send in-app message {transactional_message_id} to {identifiers}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          identifiers: requestBody.identifiers
      - text: Show in-app message {transactional_message_id} to {identifiers} with data {message_data}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          identifiers: requestBody.identifiers
          message_data: requestBody.message_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/send/inbox_message'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional inbox message
      effect: write
      questions:
      - How do I deliver a notification to a user's in-app inbox?
      - Can I send a raw JSON payload to a person's notification inbox?
      instructions:
      - text: Send inbox message {transactional_message_id} to {identifiers}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          identifiers: requestBody.identifiers
      - text: Drop inbox notification {transactional_message_id} for {identifiers} with data {message_data}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          identifiers: requestBody.identifiers
          message_data: requestBody.message_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/send/push'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional push notification
      effect: write
      questions:
      - How do I send a one-off push notification to a person's devices?
      - Can I override the title and image of a transactional push?
      instructions:
      - text: Send push {transactional_message_id} to {identifiers}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          identifiers: requestBody.identifiers
      - text: Push {transactional_message_id} with title {title} and message {message}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          title: requestBody.title
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/send/sms'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional SMS
      effect: write
      questions:
      - How do I text a verification code to a phone number?
      - Can I choose which number a transactional SMS is sent from?
      instructions:
      - text: Send SMS {transactional_message_id} to {to}.
        slots:
          transactional_message_id: requestBody.transactional_message_id
          to: requestBody.to
      - text: Text {to} using SMS template {transactional_message_id} from {from}.
        slots:
          to: requestBody.to
          transactional_message_id: requestBody.transactional_message_id
          from: requestBody.from
      method: generated
      generated: '2026-09-26'