Hightouch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hightouch Campaigns API

3 actions 3 updates phrasing extends openapi/hightouch-campaigns-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['/campaigns/{campaignId}/trigger'].post

$.paths['/campaigns/{campaignId}/sends/{sendId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hightouch Campaigns API
  version: 1.0.0
extends: openapi/hightouch-campaigns-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['/campaigns/{campaignId}/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an API-triggered campaign to recipients
      effect: write
      questions:
      - How do I send an API-triggered campaign to a list of recipients in Hightouch?
      - Can I share personalization properties across every recipient of a campaign send?
      - Is it possible to send a campaign that hasn't been activated yet, as a draft test?
      instructions:
      - text: Trigger campaign {campaignId} for recipients {recipients}.
        slots:
          campaignId: path.campaignId
          recipients: requestBody.recipients
      - text: Send campaign {campaignId} to {recipients} with shared properties {properties}.
        slots:
          campaignId: path.campaignId
          recipients: requestBody.recipients
          properties: requestBody.properties
      - text: Send draft campaign {campaignId} to test recipients {recipients} even though it isn't activated ({draft}).
        slots:
          campaignId: path.campaignId
          recipients: requestBody.recipients
          draft: requestBody.draft
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{campaignId}/sends/{sendId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the delivery status of a campaign send
      effect: read
      questions:
      - Did my triggered campaign send actually get delivered?
      - What is the delivery status of a single send I started from an API campaign?
      instructions:
      - text: Get the delivery status of send {sendId} for campaign {campaignId}.
        slots:
          sendId: path.sendId
          campaignId: path.campaignId
      - text: Check whether send {sendId} from campaign {campaignId} was delivered.
        slots:
          sendId: path.sendId
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'