SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Checklist Items API

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

$.info
$.paths['/checklists/{checklistId}/items'].post
$.paths['/checklists/{checklistId}/items/{itemId}'].put
$.paths['/checklists/{checklistId}/items/{itemId}'].post
$.paths['/checklists/{checklistId}/items/{itemId}'].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 Checklist Items API
  version: 1.0.0
extends: openapi/sendpulse-checklist-items-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: 4
- target: $.paths['/checklists/{checklistId}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an item to a checklist
      effect: write
      questions:
      - How do I add a new item to a checklist?
      - Can I create a checklist item that's already marked done?
      instructions:
      - text: Add item {name} to checklist {checklistId}.
        slots:
          name: requestBody.name
          checklistId: path.checklistId
      - text: Create a new entry in checklist {checklistId}.
        slots:
          checklistId: path.checklistId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/checklists/{checklistId}/items/{itemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit or tick off a checklist item
      effect: write
      questions:
      - Can I mark a checklist item as done?
      - Is it possible to rename an item on a checklist?
      instructions:
      - text: Mark item {itemId} in checklist {checklistId} as done {isDone}.
        slots:
          itemId: path.itemId
          checklistId: path.checklistId
          isDone: requestBody.isDone
      - text: Rename checklist {checklistId} item {itemId} to {name}.
        slots:
          checklistId: path.checklistId
          itemId: path.itemId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/checklists/{checklistId}/items/{itemId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder an item in a checklist
      effect: write
      questions:
      - Can I change the position of an item in a checklist?
      - What's the way to move a checklist item up or down?
      instructions:
      - text: Move item {itemId} in checklist {checklistId} to position {order}.
        slots:
          itemId: path.itemId
          checklistId: path.checklistId
          order: requestBody.order
      - text: Reorder checklist {checklistId} so item {itemId} comes first.
        slots:
          checklistId: path.checklistId
          itemId: path.itemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/checklists/{checklistId}/items/{itemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a checklist item
      effect: destructive
      questions:
      - Can I delete one item from a checklist?
      - What happens when I remove a checklist item?
      instructions:
      - text: Delete item {itemId} from checklist {checklistId}.
        slots:
          itemId: path.itemId
          checklistId: path.checklistId
      - text: Remove checklist {checklistId} entry {itemId}.
        slots:
          checklistId: path.checklistId
          itemId: path.itemId
      method: generated
      generated: '2026-10-01'