SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Company history API

2 actions 2 updates phrasing extends openapi/sendpulse-company-history-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for SendPulse's API. It is a proposal applied on top of the contract, not a document SendPulse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/companies/{companyId}/history'].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 SendPulse CRM Public Company history API
  version: 1.0.0
extends: openapi/sendpulse-company-history-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/companies/{companyId}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's change history
      effect: read
      questions:
      - What changes have been made to a company record in my CRM?
      - Can I see a company's history for a date range?
      instructions:
      - text: Show the change history of company {companyId} from {dateFrom} to {dateTo}.
        slots:
          companyId: path.companyId
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: List the last {limit} history events for a company record.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-02'