Leadping · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Leadping Automations API
10 actions
10 updates
phrasing
extends
openapi/leadping-automations-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Leadping's API. It is a proposal applied on top of the contract, not a document Leadping publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/automations'].post
$.paths['/automations/{id}'].get
$.paths['/automations/{id}'].put
$.paths['/automations/{id}'].delete
$.paths['/automations/{id}/runs'].get
$.paths['/automations/{id}/runs/{runId}'].get
$.paths['/automations/all/my'].post
$.paths['/automations/preview'].post
$.paths['/automations/{id}/run'].post
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 Leadping Automations API
version: 1.0.0
extends: openapi/leadping-automations-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/automations'].post
update:
x-apievangelist-phrasing:
intent: Create a lead follow-up automation
effect: write
questions:
- How do I set up an automation that follows up with new leads?
- Can I build a follow-up workflow with triggers and message steps?
- What do I need to define when creating a new automation?
instructions:
- text: Create a new follow-up automation named {name}.
slots:
name: requestBody.name
- text: 'Set up automation {name} with these triggers: {triggers}.'
slots:
name: requestBody.name
triggers: requestBody.triggers
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a follow-up automation
effect: read
questions:
- Which triggers and message steps does this automation use?
- Can I check whether a specific automation is enabled?
instructions:
- text: Show me the configuration of automation {id}.
slots:
id: path.id
- text: Look up automation {id} and tell me if it's turned on.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a follow-up automation
effect: write
questions:
- How do I change the triggers on an existing automation?
- Can I disable an automation without deleting it?
- Is it possible to edit the message steps of a follow-up workflow I already built?
instructions:
- text: Rename automation {id} to {name}.
slots:
id: path.id
name: requestBody.name
- text: Turn automation {id} (named {name}) enabled={enabled}.
slots:
id: path.id
name: requestBody.name
enabled: requestBody.enabled
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a follow-up automation
effect: destructive
questions:
- How do I permanently remove an automation so it stops scheduling follow-ups?
- What happens to lead follow-up when I delete an automation?
instructions:
- text: Delete automation {id}.
slots:
id: path.id
- text: Remove the follow-up automation {id} for good.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/{id}/runs'].get
update:
x-apievangelist-phrasing:
intent: List an automation's recent runs
effect: read
questions:
- How can I see the recent execution history of an automation?
- Did my automation actually run recently, and what state did the runs end in?
instructions:
- text: List recent runs of automation {id}.
slots:
id: path.id
- text: Show the run history console for automation {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/{id}/runs/{runId}'].get
update:
x-apievangelist-phrasing:
intent: Get one automation run
effect: read
questions:
- Can I inspect the console state of a single automation run?
- What happened during a specific execution of my automation?
instructions:
- text: Show run {runId} of automation {id}.
slots:
runId: path.runId
id: path.id
- text: Open the console for automation {id} execution {runId}.
slots:
id: path.id
runId: path.runId
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/all/my'].post
update:
x-apievangelist-phrasing:
intent: List my follow-up automations
effect: read
questions:
- Which follow-up automations do I have in Leadping?
- Can I search my automations by name and sort them?
instructions:
- text: List all my automations.
- text: Search my automations for {search}.
slots:
search: requestBody.search
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/preview'].post
update:
x-apievangelist-phrasing:
intent: Preview an automation on a sample lead
effect: read
questions:
- Can I test what an automation would send before turning it on?
- Is there a way to only validate an automation's configuration without evaluating it?
- Which steps would match a sample lead for this workflow draft?
instructions:
- text: 'Preview this automation draft against a sample lead: {automation}.'
slots:
automation: requestBody.automation
- text: Validate automation draft {automation} with validate_only={validate_only}, skipping conditions and actions.
slots:
automation: requestBody.automation
validate_only: query.validate_only
method: generated
generated: '2026-09-26'
- target: $.paths['/automations/{id}/run'].post
update:
x-apievangelist-phrasing:
intent: Run an automation manually
effect: write
questions:
- How do I kick off an automation by hand through its manual trigger?
- Can I start an automation run right now instead of waiting for a trigger?
instructions:
- text: Run automation {id} now using its manual trigger.
slots:
id: path.id
- text: Manually start automation {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'