SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Task Entity API

5 actions 5 updates phrasing extends openapi/sendpulse-task-entity-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['/task-contacts/{taskId}/contact/{contactId}'].delete

$.paths['/task-deals/{taskId}/deal/{dealId}'].delete

$.paths['/task-to-task/{taskHeadId}/task/{taskId}'].delete

$.paths['/tasks/{taskId}/entity-attach'].post

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 Entity API
  version: 1.0.0
extends: openapi/sendpulse-task-entity-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['/task-contacts/{taskId}/contact/{contactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a contact from a task
      effect: destructive
      questions:
      - How do I remove a contact that's linked to a task?
      - Can I disconnect a person from a CRM task without deleting the task?
      instructions:
      - text: Detach contact {contactId} from task {taskId}.
        slots:
          contactId: path.contactId
          taskId: path.taskId
      - text: Unlink person {contactId} from task {taskId}.
        slots:
          contactId: path.contactId
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/task-deals/{taskId}/deal/{dealId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a deal from a task
      effect: destructive
      questions:
      - How do I remove a deal that's linked to a task?
      - Can I disconnect a deal from a task?
      instructions:
      - text: Detach deal {dealId} from task {taskId}.
        slots:
          dealId: path.dealId
          taskId: path.taskId
      - text: Unlink deal {dealId} from task {taskId}.
        slots:
          dealId: path.dealId
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/task-to-task/{taskHeadId}/task/{taskId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a subtask from its parent task
      effect: destructive
      questions:
      - How do I separate a subtask from its parent task?
      - Can I break the link between two tasks?
      instructions:
      - text: Detach task {taskId} from parent task {taskHeadId}.
        slots:
          taskId: path.taskId
          taskHeadId: path.taskHeadId
      - text: Unlink subtask {taskId} from {taskHeadId}.
        slots:
          taskId: path.taskId
          taskHeadId: path.taskHeadId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{taskId}/entity-attach'].post
  update:
    x-apievangelist-phrasing:
      intent: Link contacts, deals or tasks to a task
      effect: write
      questions:
      - How do I connect a task to the deals and contacts it's about?
      - Can I attach several related records to a task in one call?
      instructions:
      - text: 'Attach these records to task {taskId}: {connections}.'
        slots:
          taskId: path.taskId
          connections: requestBody.connections
      - text: Link task {taskId} to the related contacts and deals {connections}.
        slots:
          taskId: path.taskId
          connections: requestBody.connections
      method: generated
      generated: '2026-10-01'