SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Verifier Mailing List Verification API

5 actions 5 updates phrasing extends openapi/sendpulse-mailing-list-verification-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 5

$.info
$.paths['/verifier-service/send-list-to-verify'].post
$.paths['/verifier-service/get-progress'].get
$.paths['/verifier-service/check'].get
$.paths['/verifier-service/check-list'].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 Verifier Mailing List Verification API
  version: 1.0.0
extends: openapi/sendpulse-mailing-list-verification-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: 4
- target: $.paths['/verifier-service/send-list-to-verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Start verifying a mailing list
      effect: write
      questions:
      - How can I clean an entire mailing list of invalid addresses?
      - Can I send a whole list off for email verification at once?
      instructions:
      - text: Send mailing list {id} for verification.
        slots:
          id: requestBody.id
      - text: Start verifying every address in list {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verifier-service/get-progress'].get
  update:
    x-apievangelist-phrasing:
      intent: Check mailing list verification progress
      effect: read
      questions:
      - How far along is the verification of my mailing list?
      - Is the list verification I started still running?
      instructions:
      - text: Check the verification progress for mailing list {id}.
        slots:
          id: query.id
      - text: Tell me how much of list {id} has been verified so far.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verifier-service/check'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-address results of a list verification
      effect: read
      questions:
      - Which addresses in my verified mailing list came back invalid?
      - Can I page through the verification status of each email in a list?
      instructions:
      - text: Show the verification status of each address in mailing list {id}.
        slots:
          id: query.id
      - text: Get {count} verified addresses from list {id} starting at {start}.
        slots:
          count: query.count
          id: query.id
          start: query.start
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verifier-service/check-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List mailing lists that have been verified
      effect: read
      questions:
      - Which of my mailing lists have already been through verification?
      - Can I see a summary of all my verified lists?
      instructions:
      - text: List all my mailing lists that have been verified.
      - text: Show {count} verified list summaries starting at {start}.
        slots:
          count: query.count
          start: query.start
      method: generated
      generated: '2026-10-01'