SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Task Attributes API

4 actions 4 updates phrasing extends openapi/sendpulse-task-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['/tasks/{taskId}/attributes'].post

$.paths['/{boardId}/attributes/{attributeId}/values/{valueId}'].put

$.paths['/{boardId}/attributes/{attributeId}/values/{valueId}'].delete

OpenAPI Overlay

# 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 Attributes API
  version: 1.0.0
extends: openapi/sendpulse-task-attributes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/tasks/{taskId}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a custom field value on a task
      effect: write
      questions:
      - How do I fill in a custom field on a task?
      - Can I add an attribute value to a task that doesn't have one yet?
      instructions:
      - text: Set attribute {attributeId} on task {taskId} to {value}.
        slots:
          attributeId: requestBody.attributeId
          taskId: path.taskId
          value: requestBody.value
      - text: Add a value for a custom field on task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{boardId}/attributes/{attributeId}/values/{valueId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a task's custom field value
      effect: write
      questions:
      - How do I change a custom field value already set on a task?
      - Can I edit an existing task attribute value?
      instructions:
      - text: Change value {valueId} of attribute {attributeId} to {value}.
        slots:
          valueId: path.valueId
          attributeId: path.attributeId
          value: requestBody.value
      - text: On board {boardId}, update task field value {valueId} for attribute {attributeId}.
        slots:
          boardId: path.boardId
          valueId: path.valueId
          attributeId: path.attributeId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/{boardId}/attributes/{attributeId}/values/{valueId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field value from a task
      effect: destructive
      questions:
      - How do I clear a custom field value from a task?
      - Can I delete one attribute value without removing the attribute?
      instructions:
      - text: Delete value {valueId} of attribute {attributeId}.
        slots:
          valueId: path.valueId
          attributeId: path.attributeId
      - text: On board {boardId}, clear task field value {valueId} under attribute {attributeId}.
        slots:
          boardId: path.boardId
          valueId: path.valueId
          attributeId: path.attributeId
      method: generated
      generated: '2026-10-02'