Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Tasks API

7 actions 7 updates phrasing extends openapi/close-tasks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Close's API. It is a proposal applied on top of the contract, not a document Close publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/task/'].get

$.paths['/task/'].put

$.paths['/task/'].post

$.paths['/task/{id}/'].get

$.paths['/task/{id}/'].put

$.paths['/task/{id}/'].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 Close Tasks API
  version: 1.0.0
extends: openapi/close-tasks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/task/'].get
  update:
    x-apievangelist-phrasing:
      intent: List or filter tasks
      effect: read
      questions:
      - What incomplete tasks are in my inbox for today?
      - Can I list tasks assigned to a specific user that are due before a date?
      - Which tasks are open on a particular lead?
      instructions:
      - text: List tasks in the {view} view.
        slots:
          view: query.view
      - text: Show incomplete tasks assigned to {assigned_to}.
        slots:
          assigned_to: query.assigned_to
      - text: List all tasks for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task/'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update matching tasks
      effect: write
      questions:
      - Can I mark many tasks complete at once?
      - Is it possible to reassign all of one user's tasks to someone else in one call?
      instructions:
      - text: Mark all tasks on lead {lead_id} as complete.
        slots:
          lead_id: query.lead_id
      - text: Reassign every task assigned to {from_user} over to {to_user}.
        slots:
          from_user: query.assigned_to
          to_user: requestBody.assigned_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task
      effect: write
      questions:
      - How do I create a follow-up task on a lead?
      - Which task types can be created through the API?
      instructions:
      - text: Create a lead task to follow up tomorrow.
      - text: Add an outgoing call task for this lead.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a task's details
      effect: read
      questions:
      - What are the details of a specific task?
      - Can I see who a single task is assigned to and when it's due?
      instructions:
      - text: Fetch task {id}.
        slots:
          id: path.id
      - text: Show me the details of task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single task
      effect: write
      questions:
      - Can I reschedule or reassign one task?
      - Is it possible to change the text of a lead task?
      instructions:
      - text: Mark task {id} as complete.
        slots:
          id: path.id
      - text: Reassign task {id} to {assigned_to}.
        slots:
          id: path.id
          assigned_to: requestBody.assigned_to
      - text: Move task {id} to {date}.
        slots:
          id: path.id
          date: requestBody.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task
      effect: destructive
      questions:
      - Can I delete a task instead of completing it?
      - Which call permanently removes a task?
      instructions:
      - text: Delete task {id}.
        slots:
          id: path.id
      - text: Remove task {id} from the list.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'