SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Messengers API

6 actions 6 updates phrasing extends openapi/sendpulse-messengers-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 6

$.info
$.paths['/companies/{companyId}/messengers'].get
$.paths['/companies/{companyId}/messengers'].post
$.paths['/companies/{companyId}/messengers/batch'].post
$.paths['/companies/{companyId}/messengers/{messengerId}'].put
$.paths['/companies/{companyId}/messengers/{messengerId}'].delete

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 SendPulse CRM Public Messengers API
  version: 1.0.0
extends: openapi/sendpulse-messengers-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: 5
- target: $.paths['/companies/{companyId}/messengers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's messenger accounts
      effect: read
      questions:
      - Which messenger accounts are stored for a company?
      - Can I see a company's Telegram or WhatsApp contacts?
      instructions:
      - text: List messengers for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show the messenger accounts saved on company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/messengers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a messenger account to a company
      effect: write
      questions:
      - How do I add a messenger account to a company record?
      - Can I store one chat handle for a company?
      instructions:
      - text: Add messenger {data} to {entityType} {entityId}.
        slots:
          data: requestBody.data
          entityType: path.entityType
          entityId: path.entityId
      - text: Save a messenger contact on company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/companies/{companyId}/messengers/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several messengers to a company
      effect: write
      questions:
      - Can I add many messenger accounts to a company at once?
      - Is there a bulk way to load chat handles onto a company?
      instructions:
      - text: Batch add messengers {messengers} to company {companyId}.
        slots:
          messengers: requestBody.messengers
          companyId: path.companyId
      - text: Add multiple messenger accounts to company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/messengers/{messengerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a company's messenger account
      effect: write
      questions:
      - Can I edit a messenger handle saved on a company?
      - What's the way to correct one company messenger entry?
      instructions:
      - text: Update messenger {messengerId} on {entityType} {entityId} to {data}.
        slots:
          messengerId: path.messengerId
          entityType: path.entityType
          entityId: path.entityId
          data: requestBody.data
      - text: Fix messenger entry {messengerId} saved on company {companyId}.
        slots:
          messengerId: path.messengerId
          companyId: path.companyId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/companies/{companyId}/messengers/{messengerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company's messenger account
      effect: destructive
      questions:
      - Can I remove a messenger account from a company?
      - How do I delete an outdated chat handle on a company record?
      instructions:
      - text: Delete messenger {messengerId} from {entityType} {entityId}.
        slots:
          messengerId: path.messengerId
          entityType: path.entityType
          entityId: path.entityId
      - text: Remove messenger entry {messengerId} from company {companyId}.
        slots:
          messengerId: path.messengerId
          companyId: path.companyId
      method: generated
      generated: '2026-10-02'