Live Direct Marketing · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Live Direct Marketing Online Project Templates API
17 actions
17 updates
phrasing
extends
openapi/live-direct-marketing-online-project-templates-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/api/project-templates/runs/{runId}'].get
$.paths['/api/project-templates/runs/{runId}'].delete
$.paths['/api/project-templates/runs/{runId}'].patch
$.paths['/api/project-templates/runs/{runId}/steps/{stepId}'].patch
$.paths['/api/project-templates'].get
$.paths['/api/project-templates'].post
$.paths['/api/project-templates/{id}'].get
$.paths['/api/project-templates/{id}'].delete
$.paths['/api/project-templates/{id}'].patch
$.paths['/api/project-templates/{id}/steps'].post
$.paths['/api/project-templates/{id}/steps/{stepId}'].delete
$.paths['/api/project-templates/{id}/steps/{stepId}'].patch
$.paths['/api/project-templates/{id}/steps/reorder'].post
$.paths['/api/project-templates/{id}/brief-questions'].get
$.paths['/api/project-templates/{id}/summary'].get
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 Live Direct Marketing Online Project Templates API
version: 1.0.0
extends: openapi/live-direct-marketing-online-project-templates-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: 16
- target: $.paths['/api/project-templates/runs/{runId}'].get
update:
x-apievangelist-phrasing:
intent: Get a project run with steps and totals
effect: read
questions:
- How is one of my project runs going, step by step?
- What are the totals for a project run created from a template?
instructions:
- text: Show project run {runId} with its steps and totals.
slots:
runId: path.runId
- text: Fetch run {runId}.
slots:
runId: path.runId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/runs/{runId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a project run
effect: destructive
questions:
- Can I delete a project run I started by mistake?
- How do I remove a run from a template's history?
instructions:
- text: Delete project run {runId}.
slots:
runId: path.runId
- text: Remove run {runId} permanently.
slots:
runId: path.runId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/runs/{runId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a project run's name, status or notes
effect: write
questions:
- Can I mark a project run as a test or change its status?
- How do I add notes to a project run?
instructions:
- text: Update project run {runId}.
slots:
runId: path.runId
- text: Rename run {runId} and update its notes.
slots:
runId: path.runId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/runs/{runId}/steps/{stepId}'].patch
update:
x-apievangelist-phrasing:
intent: Record facts and issues on a run step
effect: write
questions:
- How do I log the actual result for a step in a project run?
- Can I attach issues, questions or ideas to one step of a run?
instructions:
- text: Update step {stepId} of run {runId}.
slots:
stepId: path.stepId
runId: path.runId
- text: Record the fact and status for run {runId} step {stepId}.
slots:
runId: path.runId
stepId: path.stepId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates'].get
update:
x-apievangelist-phrasing:
intent: List project templates
effect: read
questions:
- What project templates do I have?
- Can I include archived templates when listing them?
instructions:
- text: List my project templates.
- text: List project templates with includeArchived set to {includeArchived}.
slots:
includeArchived: query.includeArchived
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates'].post
update:
x-apievangelist-phrasing:
intent: Create a project template
effect: write
questions:
- How do I create a reusable project template?
- Can I define a new playbook template for repeat projects?
instructions:
- text: Create a new project template.
- text: Set up a reusable project playbook template.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a project template with steps and runs
effect: read
questions:
- What steps and past runs belong to a template?
- Where can I see a single project template in full?
instructions:
- text: Show project template {id} with its steps and runs.
slots:
id: path.id
- text: Open template {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a project template
effect: destructive
questions:
- Why can't I delete a template that already has runs?
- How do I delete an unused project template?
instructions:
- text: Delete project template {id}.
slots:
id: path.id
- text: Permanently remove template {id} if it has no runs.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update or archive a project template
effect: write
questions:
- Can I archive a template instead of deleting it?
- How do I rename a project template or change its description?
instructions:
- text: Archive project template {id}.
slots:
id: path.id
- text: Update the name and description of template {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}/steps'].post
update:
x-apievangelist-phrasing:
intent: Add a step to a project template
effect: write
questions:
- How do I add a new step to a project template?
- Can I extend a template with another stage?
instructions:
- text: Add a step to template {id}.
slots:
id: path.id
- text: Append a new stage to project template {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}/steps/{stepId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a step from a project template
effect: destructive
questions:
- Can I take a step out of a project template?
- How do I remove an outdated stage from a template?
instructions:
- text: Delete step {stepId} from template {id}.
slots:
stepId: path.stepId
id: path.id
- text: Remove template step {stepId} in template {id}.
slots:
stepId: path.stepId
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}/steps/{stepId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a step in a project template
effect: write
questions:
- How do I change the plan for one step in a template?
- Can I edit a template step's details?
instructions:
- text: Update step {stepId} of template {id}.
slots:
stepId: path.stepId
id: path.id
- text: Edit template {id} step {stepId}.
slots:
id: path.id
stepId: path.stepId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}/steps/reorder'].post
update:
x-apievangelist-phrasing:
intent: Reorder a project template's steps
effect: write
questions:
- Can I change the order of steps in a project template?
- How do I move a template step earlier in the sequence?
instructions:
- text: Reorder the steps of template {id}.
slots:
id: path.id
- text: Apply a new step order to project template {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}/brief-questions'].get
update:
x-apievangelist-phrasing:
intent: List all brief questions in a template
effect: read
questions:
- What brief questions does a project template ask, all in one list?
- Can I see every client brief question across a template's steps?
instructions:
- text: List all brief questions of template {id}.
slots:
id: path.id
- text: Collect the brief questions from project template {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}/summary'].get
update:
x-apievangelist-phrasing:
intent: Compare planned vs actual per template step
effect: read
questions:
- How do my finished runs compare to the plan for each template step?
- Can I see plan-versus-actual only for real runs, excluding tests?
instructions:
- text: Show the plan vs actual summary for template {id}.
slots:
id: path.id
- text: Summarize template {id} over done runs with scope {scope}.
slots:
id: path.id
scope: query.scope
method: generated
generated: '2026-10-01'
- target: $.paths['/api/project-templates/{id}/runs'].post
update:
x-apievangelist-phrasing:
intent: Start a project run from a template
effect: write
questions:
- How do I launch a new project from a template?
- Will later edits to a template change runs already created from it?
instructions:
- text: Create a run from template {id}.
slots:
id: path.id
- text: Start a new project run based on template {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'