Hightouch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hightouch Sync Sequences API

3 actions 3 updates phrasing extends openapi/hightouch-sync-sequences-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hightouch's API. It is a proposal applied on top of the contract, not a document Hightouch publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/sync-sequences/{syncSequenceId}/trigger'].post
$.paths['/sync-sequences/runs/{syncSequenceRunId}'].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 Hightouch Sync Sequences API
  version: 1.0.0
extends: openapi/hightouch-sync-sequences-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/sync-sequences/{syncSequenceId}/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a sync sequence
      effect: write
      questions:
      - How do I start a run of a sync sequence?
      - What happens if I trigger a sync sequence while it's already running?
      instructions:
      - text: Trigger sync sequence {syncSequenceId}.
        slots:
          syncSequenceId: path.syncSequenceId
      - text: Start a new run of sync sequence {syncSequenceId} now.
        slots:
          syncSequenceId: path.syncSequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sync-sequences/runs/{syncSequenceRunId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a sync sequence run
      effect: read
      questions:
      - Has my sync sequence run finished?
      - What is the current status of a particular sync sequence run?
      instructions:
      - text: Get the status of sync sequence run {syncSequenceRunId}.
        slots:
          syncSequenceRunId: path.syncSequenceRunId
      - text: Check whether sequence run {syncSequenceRunId} succeeded.
        slots:
          syncSequenceRunId: path.syncSequenceRunId
      method: generated
      generated: '2026-10-01'