SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Phones API

6 actions 6 updates phrasing extends openapi/sendpulse-phones-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}/phones'].get
$.paths['/companies/{companyId}/phones'].post
$.paths['/companies/{companyId}/phones/batch'].post
$.paths['/companies/{companyId}/phones/{phoneId}'].put
$.paths['/companies/{companyId}/phones/{phoneId}'].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 Phones API
  version: 1.0.0
extends: openapi/sendpulse-phones-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}/phones'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's phone numbers
      effect: read
      questions:
      - What phone numbers are stored for a CRM company?
      - Can I see all the contact numbers on a company record?
      instructions:
      - text: List the phone numbers of company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show every phone stored on company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/phones'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a phone number to a company
      effect: write
      questions:
      - How do I add one phone number to a company record?
      - Can I attach a new main line to an existing company?
      instructions:
      - text: Add phone {data} to company {companyId}.
        slots:
          data: requestBody.data
          companyId: path.companyId
      - text: Attach a single new phone number {data} to company {companyId}.
        slots:
          data: requestBody.data
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/phones/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several phone numbers to a company at once
      effect: write
      questions:
      - Can I add multiple phone numbers to a company in one request?
      - Is there a bulk way to load a company's phone list?
      instructions:
      - text: Add phones {phones} to company {companyId} in one batch.
        slots:
          phones: requestBody.phones
          companyId: path.companyId
      - text: 'Bulk-create these phone numbers on company {companyId}: {phones}.'
        slots:
          companyId: path.companyId
          phones: requestBody.phones
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/phones/{phoneId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a company phone number
      effect: write
      questions:
      - How do I correct a phone number already saved on a company?
      - Can I edit an existing company phone entry?
      instructions:
      - text: Change phone {phoneId} on {entityType} {entityId} to {data}.
        slots:
          phoneId: path.phoneId
          entityType: path.entityType
          entityId: path.entityId
          data: requestBody.data
      - text: Correct phone entry {phoneId} saved on company {companyId}.
        slots:
          phoneId: path.phoneId
          companyId: path.companyId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/companies/{companyId}/phones/{phoneId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company phone number
      effect: destructive
      questions:
      - How do I remove an outdated phone number from a company?
      - Can I delete one phone entry from a company record?
      instructions:
      - text: Delete phone {phoneId} from {entityType} {entityId}.
        slots:
          phoneId: path.phoneId
          entityType: path.entityType
          entityId: path.entityId
      - text: Remove phone entry {phoneId} from company {companyId}.
        slots:
          phoneId: path.phoneId
          companyId: path.companyId
      method: generated
      generated: '2026-10-02'