Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Custom Objects API

7 actions 7 updates phrasing extends openapi/klaviyo-custom-objects-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Klaviyo's API. It is a proposal applied on top of the contract, not a document Klaviyo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/data-sources'].get
$.paths['/api/data-sources'].post
$.paths['/api/data-sources/{id}'].get
$.paths['/api/data-sources/{id}'].delete
$.paths['/api/data-source-record-bulk-create-jobs'].post
$.paths['/api/data-source-record-create-jobs'].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 Klaviyo Custom Objects API
  version: 1.0.0
extends: openapi/klaviyo-custom-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: 6
- target: $.paths['/api/data-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom object data sources
      effect: read
      questions:
      - What custom object data sources are set up in my account?
      - Can I page through my data sources a few at a time?
      instructions:
      - text: List my data sources, {page_size} per page.
        slots:
          page_size: query.page[size]
      - text: Show all custom object data sources.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom object data source
      effect: write
      questions:
      - How do I set up a new data source for custom objects?
      - Can I register a source for importing records like loyalty or bookings?
      instructions:
      - text: Create a data source {source}.
        slots:
          source: requestBody.data
      - text: 'Register a new custom object data source: {source}.'
        slots:
          source: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-sources/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one data source
      effect: read
      questions:
      - What are the details of a specific data source?
      - Can I look up a custom object data source by ID?
      instructions:
      - text: Get data source {source_id}.
        slots:
          source_id: path.id
      - text: Show the settings of data source {source_id}.
        slots:
          source_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-sources/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data source
      effect: destructive
      questions:
      - Can I delete a custom object data source?
      - What's the way to remove a data source I no longer need?
      instructions:
      - text: Delete data source {source_id}.
        slots:
          source_id: path.id
      - text: Permanently remove custom object data source {source_id}.
        slots:
          source_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-source-record-bulk-create-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a batch of data source records
      effect: write
      questions:
      - How do I import up to 500 custom object records at once?
      - What are the payload size limits for a bulk record import?
      instructions:
      - text: 'Start a bulk import of these records: {records}.'
        slots:
          records: requestBody.data
      - text: Bulk load custom object records {records}.
        slots:
          records: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-source-record-create-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a single data source record
      effect: write
      questions:
      - Can I push one custom object record as it happens?
      - What's the size limit for a single record import?
      instructions:
      - text: Import one record {record}.
        slots:
          record: requestBody.data
      - text: 'Create a single custom object record: {record}.'
        slots:
          record: requestBody.data
      method: generated
      generated: '2026-09-26'