SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Tasks boards API

5 actions 5 updates phrasing extends openapi/sendpulse-tasks-boards-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['/boards'].get
$.paths['/boards'].post
$.paths['/boards/{boardId}'].get
$.paths['/boards/{boardId}'].put

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 boards API
  version: 1.0.0
extends: openapi/sendpulse-tasks-boards-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['/boards'].get
  update:
    x-apievangelist-phrasing:
      intent: List task boards
      effect: read
      questions:
      - What task boards do I have?
      - Can I see every board in my CRM task manager?
      instructions:
      - text: List all my task boards.
      - text: Show every task board.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/boards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task board
      effect: write
      questions:
      - How do I create a new board for tasks?
      - Can I set up a task board with custom settings?
      instructions:
      - text: Create a task board named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new board {name} with settings {settings}.
        slots:
          name: requestBody.name
          settings: requestBody.settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/boards/{boardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task board and its settings
      effect: read
      questions:
      - What settings does a particular task board have?
      - Can I open one task board by ID?
      instructions:
      - text: Show task board {boardId}.
        slots:
          boardId: path.boardId
      - text: Get the settings of board {boardId}.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/boards/{boardId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a task board
      effect: write
      questions:
      - Can I rename a task board or change its settings?
      - Is it possible to edit an existing board's configuration?
      instructions:
      - text: Rename task board {boardId} to {name}.
        slots:
          boardId: path.boardId
          name: requestBody.name
      - text: Update board {boardId} settings to {settings}.
        slots:
          boardId: path.boardId
          settings: requestBody.settings
      method: generated
      generated: '2026-10-01'