SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Bulk Email Balance API

4 actions 4 updates phrasing extends openapi/sendpulse-balance-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 4

$.info
$.paths['/balance'].get
$.paths['/balance/{currency}'].get
$.paths['/user/balance/detail'].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 SendPulse Bulk Email Balance API
  version: 1.0.0
extends: openapi/sendpulse-balance-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: 3
- target: $.paths['/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the overall account balance
      effect: read
      questions:
      - How much money is left in my SendPulse account?
      - What is my current account balance?
      instructions:
      - text: Show my account balance.
      - text: Check how much credit I have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/balance/{currency}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account balance in a currency
      effect: read
      questions:
      - What is my balance expressed in a specific currency?
      - Can I see my balance in euros or dollars?
      instructions:
      - text: Show my balance in {currency}.
        slots:
          currency: path.currency
      - text: Get my account balance converted to {currency}.
        slots:
          currency: path.currency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/balance/detail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detailed balance, tariffs and limits
      effect: read
      questions:
      - Which tariff plans and limits apply to each service on my account?
      - Can I see a detailed breakdown of my balance across services?
      instructions:
      - text: Show my detailed balance with tariffs and limits.
      - text: Break down my balance and plan limits per service.
      method: generated
      generated: '2026-10-01'