SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Tasks API

9 actions 9 updates phrasing extends openapi/sendpulse-tasks-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 9

$.info
$.paths['/tasks/list'].post
$.paths['/tasks'].post
$.paths['/tasks-repeat/templates'].get
$.paths['/tasks/{taskId}'].get
$.paths['/tasks/{taskId}'].put
$.paths['/tasks/{taskId}'].delete
$.paths['/tasks/{taskId}/parent'].post
$.paths['/tasks/{taskId}/steps/{stepId}/order'].post

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 Tasks API
  version: 1.0.0
extends: openapi/sendpulse-tasks-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: 8
- target: $.paths['/tasks/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search tasks with filters
      effect: read
      questions:
      - Which tasks are assigned to a given person on my board?
      - Can I find tasks by priority, tag or due date range?
      - How do I list tasks linked to a particular deal?
      instructions:
      - text: List tasks on board {boardId}.
        slots:
          boardId: requestBody.boardId
      - text: Find tasks assigned to user {responsibleId} with priority {priority}.
        slots:
          responsibleId: requestBody.responsibleId
          priority: requestBody.priority
      - text: Show tasks for the deal named {dealName}.
        slots:
          dealName: requestBody.dealName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task
      effect: write
      questions:
      - How do I create a task on a board with a due date?
      - Can I make a recurring task that repeats weekly?
      - Is it possible to add a checklist and tags when creating a task?
      instructions:
      - text: Create a task {name} on board {boardId}.
        slots:
          name: requestBody.name
          boardId: requestBody.boardId
      - text: Add task {name} assigned to {responsibleId}, due {finishAt}.
        slots:
          name: requestBody.name
          responsibleId: requestBody.responsibleId
          finishAt: requestBody.finishAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks-repeat/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List task repeat templates
      effect: read
      questions:
      - What repeat templates are available for recurring tasks?
      - Which recurrence options can a task use?
      instructions:
      - text: List the task repeat templates.
      - text: Show the available recurring-task templates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task by ID
      effect: read
      questions:
      - Can I fetch the full details of one task?
      - What information is stored on a single task?
      instructions:
      - text: Get task {taskId}.
        slots:
          taskId: path.taskId
      - text: Show me the details of task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a task
      effect: write
      questions:
      - How do I change a task's due date or assignee?
      - Can I move a task to a different board or step by editing it?
      instructions:
      - text: Change the due date of task {taskId} to {finishAt}.
        slots:
          taskId: path.taskId
          finishAt: requestBody.finishAt
      - text: Reassign task {taskId} to user {responsibleId}.
        slots:
          taskId: path.taskId
          responsibleId: requestBody.responsibleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task
      effect: destructive
      questions:
      - Can I delete a task I no longer need?
      - What's the way to remove a task by ID?
      instructions:
      - text: Delete task {taskId}.
        slots:
          taskId: path.taskId
      - text: Remove task {taskId} from the board.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/parent'].post
  update:
    x-apievangelist-phrasing:
      intent: Set or clear a task's parent task
      effect: write
      questions:
      - Can I make a task a subtask of another task?
      - Is it possible to detach a subtask from its parent?
      instructions:
      - text: Make task {taskId} a subtask of {parentId}.
        slots:
          taskId: path.taskId
          parentId: requestBody.parentId
      - text: Unset the parent of task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/steps/{stepId}/order'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder a task or move it to another step
      effect: write
      questions:
      - Can I change a task's position within its step?
      - How do I move a task card into another step at a specific position?
      instructions:
      - text: Move task {taskId} in step {stepId} to position {order}.
        slots:
          taskId: path.taskId
          stepId: path.stepId
          order: requestBody.order
      - text: Move task {taskId} from step {stepId} to step {newStepId} at position {order}.
        slots:
          taskId: path.taskId
          stepId: path.stepId
          newStepId: requestBody.newStepId
          order: requestBody.order
      method: generated
      generated: '2026-10-01'