SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Bulk Email Blacklist API

4 actions 4 updates phrasing extends openapi/sendpulse-blacklist-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['/blacklist'].get

$.paths['/blacklist'].post

$.paths['/blacklist'].delete

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 Bulk Email Blacklist API
  version: 1.0.0
extends: openapi/sendpulse-blacklist-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['/blacklist'].get
  update:
    x-apievangelist-phrasing:
      intent: List blacklisted email addresses
      effect: read
      questions:
      - Which email addresses are on my blacklist?
      - Can I review the blocked addresses in my account?
      instructions:
      - text: List my blacklisted emails.
      - text: Show every address on the blacklist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blacklist'].post
  update:
    x-apievangelist-phrasing:
      intent: Add email addresses to the blacklist
      effect: write
      questions:
      - How do I block email addresses from ever receiving my mailings?
      - Can I leave a comment when blacklisting addresses?
      instructions:
      - text: Blacklist {emails}.
        slots:
          emails: requestBody.emails
      - text: Add {emails} to the blacklist with comment {comment}.
        slots:
          emails: requestBody.emails
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blacklist'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove email addresses from the blacklist
      effect: destructive
      questions:
      - Can I unblock an address I blacklisted by mistake?
      - What's the way to take emails off the blacklist?
      instructions:
      - text: Remove {emails} from the blacklist.
        slots:
          emails: requestBody.emails
      - text: 'Unblock these addresses: {emails}.'
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'