SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Board attributes API

4 actions 4 updates phrasing extends openapi/sendpulse-board-attributes-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 4

$.info
$.paths['/boards/{boardId}/attributes'].get
$.paths['/boards/{boardId}/attributes'].post
$.paths['/boards/{boardId}/attributes/{attributeId}'].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 Board attributes API
  version: 1.0.0
extends: openapi/sendpulse-board-attributes-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: 3
- target: $.paths['/boards/{boardId}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the task attributes defined on a board
      effect: read
      questions:
      - What custom fields do tasks on a particular board have?
      - Can I see the attribute definitions for a task board?
      instructions:
      - text: List the attributes defined on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show the custom task fields for board {boardId}.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/boards/{boardId}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task attribute on a board
      effect: write
      questions:
      - How do I add a custom field to all tasks on a board?
      - Can I create a mandatory board attribute with preset options?
      instructions:
      - text: Create attribute {name} on board {boardId}.
        slots:
          name: requestBody.name
          boardId: path.boardId
      - text: Add a {type} task field {name} to board {boardId} with options {options}.
        slots:
          type: requestBody.type
          name: requestBody.name
          boardId: path.boardId
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/boards/{boardId}/attributes/{attributeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a board's task attribute definition
      effect: write
      questions:
      - How do I rename a custom field on a task board?
      - Can I reorder or disable a board attribute?
      instructions:
      - text: Rename attribute {attributeId} on board {boardId} to {name}.
        slots:
          attributeId: path.attributeId
          boardId: path.boardId
          name: requestBody.name
      - text: Move board {boardId} field {attributeId} to position {order}.
        slots:
          boardId: path.boardId
          attributeId: path.attributeId
          order: requestBody.order
      method: generated
      generated: '2026-10-01'