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 Flows API
version: 1.0.0
extends: openapi/sendpulse-flows-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['/flows'].get
update:
x-apievangelist-phrasing:
intent: List a chatbot's flows
effect: read
questions:
- What flows have I built for my chatbot?
- Can I see each bot flow's status and the trigger that launches it?
instructions:
- text: List the flows for bot {bot_id}.
slots:
bot_id: query.bot_id
- text: Show {size} flows of bot {bot_id}, skipping {skip}.
slots:
size: query.size
bot_id: query.bot_id
skip: query.skip
method: generated
generated: '2026-10-01'
- target: $.paths['/flows/run'].post
update:
x-apievangelist-phrasing:
intent: Run a chatbot flow for a contact by flow ID
effect: write
questions:
- How do I start a specific chatbot flow for one subscriber?
- Can I pass external data into a flow when I launch it?
instructions:
- text: Run flow {flow_id} for contact {contact_id}.
slots:
flow_id: requestBody.flow_id
contact_id: requestBody.contact_id
- text: Launch flow {flow_id} for contact {contact_id} with data {external_data}.
slots:
flow_id: requestBody.flow_id
contact_id: requestBody.contact_id
external_data: requestBody.external_data
method: generated
generated: '2026-10-01'
- target: $.paths['/flows/runByTrigger'].post
update:
x-apievangelist-phrasing:
intent: Run a chatbot flow by trigger keyword
effect: write
questions:
- Can I launch a bot flow by its trigger keyword instead of its ID?
- How do I fire the flow that a keyword would start for a contact?
instructions:
- text: Trigger the keyword {trigger_keyword} flow for contact {contact_id}.
slots:
trigger_keyword: requestBody.trigger_keyword
contact_id: requestBody.contact_id
- text: Start whichever flow keyword {trigger_keyword} launches for contact {contact_id}, passing {external_data}.
slots:
trigger_keyword: requestBody.trigger_keyword
contact_id: requestBody.contact_id
external_data: requestBody.external_data
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.