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.
# 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 Reports API
version: 1.0.0
extends: openapi/sendpulse-reports-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['/verifier-service/make-report'].post
update:
x-apievangelist-phrasing:
intent: Generate a list verification report
effect: write
questions:
- How do I generate a downloadable report of my list verification results?
- Can I build the report only for invalid addresses and in CSV?
instructions:
- text: Create a verification report for list {id}.
slots:
id: requestBody.id
- text: Make a {format} verification report for list {id} with status {status}.
slots:
format: requestBody.format
id: requestBody.id
status: requestBody.status
method: generated
generated: '2026-10-01'
- target: $.paths['/verifier-service/check-report'].get
update:
x-apievangelist-phrasing:
intent: Preview a list verification report
effect: read
questions:
- Can I preview a verification report before downloading it?
- Is my verification report ready yet?
instructions:
- text: Check the verification report for list {id}.
slots:
id: query.id
- text: Show a sample of the {format} verification report for list {id}.
slots:
format: query.format
id: query.id
method: generated
generated: '2026-10-01'
- target: $.paths['/verifier-service/get-report'].get
update:
x-apievangelist-phrasing:
intent: Download a list verification report
effect: read
questions:
- How do I download the full verification report file?
- Does the report stay on the server after I download it?
instructions:
- text: Download the verification report for list {id}.
slots:
id: query.id
- text: Get the full {format} verification report file for list {id}.
slots:
format: query.format
id: query.id
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.