Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Objects API

5 actions 5 updates phrasing extends openapi/customer-io-objects-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/object_types'].get
$.paths['/v1/objects'].post
$.paths['/v1/objects/{object_type_id}/{object_id}/relationships'].get
$.paths['/v1/objects/{object_type_id}/{object_id}/attributes'].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 Objects API
  version: 1.0.0
extends: openapi/customer-io-objects-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/object_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List object types
      effect: read
      questions:
      - What object types, like companies or accounts, exist in my workspace?
      - How do I find the ID of an object type?
      instructions:
      - text: List my object types.
      - text: Show the IDs of every object type in this workspace.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Find objects matching a filter
      effect: read
      questions:
      - How do I find all accounts whose plan attribute is enterprise?
      - Can I search objects of one type by their attributes?
      instructions:
      - text: Find objects of type {object_type_id} matching {filter}.
        slots:
          object_type_id: requestBody.object_type_id
          filter: requestBody.filter
      - text: Search up to {limit} objects of type {object_type_id} where {filter}.
        slots:
          limit: query.limit
          object_type_id: requestBody.object_type_id
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/objects/{object_type_id}/{object_id}/relationships'].get
  update:
    x-apievangelist-phrasing:
      intent: List people related to an object
      effect: read
      questions:
      - Which people belong to a given company or account object?
      - How do I page through the people related to an object?
      instructions:
      - text: List people related to object {object_id} of type {object_type_id}.
        slots:
          object_id: path.object_id
          object_type_id: path.object_type_id
      - text: Show the members of account {object_id} (object type {object_type_id}).
        slots:
          object_id: path.object_id
          object_type_id: path.object_type_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/objects/{object_type_id}/{object_id}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's attributes
      effect: read
      questions:
      - What attributes are stored on a particular account object?
      - How do I see an object's billing date or name?
      instructions:
      - text: Get attributes for object {object_id} of type {object_type_id}.
        slots:
          object_id: path.object_id
          object_type_id: path.object_type_id
      - text: Show what we know about object {object_id} in type {object_type_id}.
        slots:
          object_id: path.object_id
          object_type_id: path.object_type_id
      method: generated
      generated: '2026-09-26'