SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Task Checklist API

7 actions 7 updates phrasing extends openapi/sendpulse-task-checklist-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 7

$.info
$.paths['/tasks/{taskId}/checklists/single'].post
$.paths['/tasks/{taskId}/checklists/{checklistId}/single'].put
$.paths['/tasks/{taskId}/checklists'].get
$.paths['/tasks/{taskId}/checklists'].put
$.paths['/tasks/{taskId}/checklists'].post
$.paths['/tasks/{taskId}/checklists/{checklistId}'].delete

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 CRM Public Task Checklist API
  version: 1.0.0
extends: openapi/sendpulse-task-checklist-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: 6
- target: $.paths['/tasks/{taskId}/checklists/single'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an empty checklist to a task
      effect: write
      questions:
      - Can I add a blank checklist to a task?
      - Is there a way to create one checklist with no items yet?
      instructions:
      - text: Add an empty checklist {name} to task {taskId}.
        slots:
          name: requestBody.name
          taskId: path.taskId
      - text: Create a single checklist on task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/checklists/{checklistId}/single'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a single task checklist
      effect: write
      questions:
      - Can I rename one checklist on a task without touching its items?
      - What's the way to change a single checklist's title?
      instructions:
      - text: Rename checklist {checklistId} on task {taskId} to {name}.
        slots:
          checklistId: path.checklistId
          taskId: path.taskId
          name: requestBody.name
      - text: Update only the name of checklist {checklistId} in task {taskId}.
        slots:
          checklistId: path.checklistId
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/checklists'].get
  update:
    x-apievangelist-phrasing:
      intent: List a task's checklists
      effect: read
      questions:
      - What checklists are on a task?
      - Can I see a task's checklists and their items?
      instructions:
      - text: List the checklists on task {taskId}.
        slots:
          taskId: path.taskId
      - text: Show checklist progress for task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/checklists'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several task checklists with items
      effect: write
      questions:
      - Can I update multiple checklists and their items on a task at once?
      - Is there a bulk edit for a task's checklists?
      instructions:
      - text: Update the checklists on task {taskId} with {checklists}.
        slots:
          taskId: path.taskId
          checklists: requestBody.checklists
      - text: Bulk edit all checklist items in task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/checklists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create several checklists with items on a task
      effect: write
      questions:
      - How do I add multiple checklists, items included, to a task?
      - Can I create checklists and their items in one request?
      instructions:
      - text: Create checklists {checklists} on task {taskId}.
        slots:
          checklists: requestBody.checklists
          taskId: path.taskId
      - text: Add several checklists with items to task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/checklists/{checklistId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a checklist from a task
      effect: destructive
      questions:
      - Can I delete a checklist from a task?
      - What's the way to remove one checklist and its items?
      instructions:
      - text: Delete checklist {checklistId} from task {taskId}.
        slots:
          checklistId: path.checklistId
          taskId: path.taskId
      - text: Remove checklist {checklistId} on task {taskId}.
        slots:
          checklistId: path.checklistId
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'