Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.task Completions API

4 actions 4 updates phrasing extends openapi/close-activities-task-completions-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 4

$.info

$.paths['/activity/task_completed/'].get

$.paths['/activity/task_completed/{id}/'].get

$.paths['/activity/task_completed/{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 Activities.task Completions API
  version: 1.0.0
extends: openapi/close-activities-task-completions-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: 3
- target: $.paths['/activity/task_completed/'].get
  update:
    x-apievangelist-phrasing:
      intent: List completed-task activities
      effect: read
      questions:
      - Which tasks were completed on a lead?
      - Can I see tasks a rep finished last week?
      instructions:
      - text: List completed tasks on lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show tasks completed by user {user_id} since {activity_at__gte}.
        slots:
          user_id: query.user_id
          activity_at__gte: query.activity_at__gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/task_completed/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a completed-task activity
      effect: read
      questions:
      - How do I look up one task completion record?
      - What's in a single task-completed activity?
      instructions:
      - text: Show task completion activity {id}.
        slots:
          id: path.id
      - text: Fetch completed-task record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/task_completed/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a completed-task activity
      effect: destructive
      questions:
      - Can I remove a task completion entry from the timeline?
      - What's the way to delete a task-completed activity?
      instructions:
      - text: Delete task completion activity {id}.
        slots:
          id: path.id
      - text: Remove completed-task record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'