SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Bulk Email Senders API

6 actions 6 updates phrasing extends openapi/sendpulse-senders-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['/senders'].get
$.paths['/senders'].post
$.paths['/senders'].delete
$.paths['/senders/{email}/code'].get
$.paths['/senders/{email}/code'].post

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 Senders API
  version: 1.0.0
extends: openapi/sendpulse-senders-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: 5
- target: $.paths['/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List sender addresses
      effect: read
      questions:
      - Which From addresses are authorized on my account?
      - Can I check which sender emails are active?
      instructions:
      - text: List my sender addresses.
      - text: Show all authorized From emails.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sender address
      effect: write
      questions:
      - How do I register a new From address for my emails?
      - Can I add a sender with a display name?
      instructions:
      - text: Add sender {email} named {name}.
        slots:
          email: requestBody.email
          name: requestBody.name
      - text: Register {email} as a From address with name {name}.
        slots:
          email: requestBody.email
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sender address
      effect: destructive
      questions:
      - Can I remove a sender address I don't use anymore?
      - What's the way to revoke an authorized From email?
      instructions:
      - text: Delete sender {email}.
        slots:
          email: requestBody.email
      - text: Remove {email} from my authorized senders.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{email}/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a sender activation code
      effect: write
      questions:
      - How do I get the activation code for a new sender address?
      - Can I resend the verification email for a sender?
      instructions:
      - text: Send an activation code to sender {email}.
        slots:
          email: path.email
      - text: Request a new verification email for {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{email}/code'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a sender with its code
      effect: write
      questions:
      - Where do I enter the code to verify a sender address?
      - Can I activate a sender once I've received the code?
      instructions:
      - text: Activate sender {email} with code {code}.
        slots:
          email: path.email
          code: requestBody.code
      - text: Verify {email} using activation code {code}.
        slots:
          email: path.email
          code: requestBody.code
      method: generated
      generated: '2026-10-01'