SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse SMTP Unsubscribe API

6 actions 6 updates phrasing extends openapi/sendpulse-unsubscribe-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['/smtp/unsubscribe'].get
$.paths['/smtp/unsubscribe'].post
$.paths['/smtp/unsubscribe'].delete
$.paths['/smtp/unsubscribe/search'].get
$.paths['/smtp/resubscribe'].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 SMTP Unsubscribe API
  version: 1.0.0
extends: openapi/sendpulse-unsubscribe-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['/smtp/unsubscribe'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMTP unsubscribed recipients
      effect: read
      questions:
      - Who has unsubscribed from my transactional emails?
      - Can I see SMTP unsubscribes for a specific date?
      instructions:
      - text: List SMTP unsubscribed users.
      - text: Show SMTP unsubscribes on {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe recipients from SMTP emails
      effect: write
      questions:
      - How do I stop sending transactional emails to a recipient?
      - Can I add addresses to the SMTP unsubscribe list?
      instructions:
      - text: Unsubscribe these recipients from SMTP emails.
      - text: Add this address to my SMTP unsubscribe list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/unsubscribe'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an email from the SMTP unsubscribe list
      effect: destructive
      questions:
      - Can I take an email back off the SMTP unsubscribed list?
      - What's the way to delete an entry from SMTP unsubscribes?
      instructions:
      - text: Remove this email from the SMTP unsubscribed list.
      - text: Delete the SMTP unsubscribe record for this address.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/unsubscribe/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a contact's SMTP subscription status
      effect: read
      questions:
      - Is a given email address unsubscribed from SMTP sends?
      - Can I check why a recipient is not getting transactional emails?
      instructions:
      - text: Check SMTP subscription status for {email}.
        slots:
          email: query.email
      - text: Look up whether {email} is unsubscribed.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/resubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Resubscribe a recipient to SMTP emails
      effect: write
      questions:
      - How do I resubscribe someone who opted out of transactional email?
      - Can a resubscribe confirmation be sent in a specific language?
      instructions:
      - text: Resubscribe {email} from sender {sender}.
        slots:
          email: requestBody.email
          sender: requestBody.sender
      - text: Send a resubscribe request to {email} from {sender} in {lang}.
        slots:
          email: requestBody.email
          sender: requestBody.sender
          lang: requestBody.lang
      method: generated
      generated: '2026-10-01'