Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.calls API

6 actions 6 updates phrasing extends openapi/close-activities-calls-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 6

$.info
$.paths['/activity/call/'].get
$.paths['/activity/call/'].post
$.paths['/activity/call/{id}/'].get
$.paths['/activity/call/{id}/'].put
$.paths['/activity/call/{id}/'].delete

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 Close Activities.calls API
  version: 1.0.0
extends: openapi/close-activities-calls-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: 5
- target: $.paths['/activity/call/'].get
  update:
    x-apievangelist-phrasing:
      intent: List call activities
      effect: read
      questions:
      - Which calls were logged against a particular lead?
      - Can I filter call activity by rep and date range?
      instructions:
      - text: List call activities for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show calls made 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/call/'].post
  update:
    x-apievangelist-phrasing:
      intent: Log an external call
      effect: write
      questions:
      - How do I log a call made outside the built-in dialer?
      - Can I attach a recording URL when logging a phone call?
      instructions:
      - text: Log an outbound call to {phone} on lead {lead_id}.
        slots:
          phone: requestBody.phone
          lead_id: requestBody.lead_id
      - text: Log a {duration}-second call on lead {lead_id} with note {note}.
        slots:
          duration: requestBody.duration
          lead_id: requestBody.lead_id
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/call/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single call activity
      effect: read
      questions:
      - Where can I see the details and notes of one call?
      - How do I look up a call's duration and outcome?
      instructions:
      - text: Show call activity {id}.
        slots:
          id: path.id
      - text: Fetch the recording and notes for call {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/call/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a call's notes or outcome
      effect: write
      questions:
      - Can I change the outcome of a call after it ended?
      - Why can't I change duration on calls made through the built-in VoIP?
      instructions:
      - text: Set the outcome of call {id} to {outcome_id}.
        slots:
          id: path.id
          outcome_id: requestBody.outcome_id
      - text: Replace the notes on call {id} with {note_html}.
        slots:
          id: path.id
          note_html: requestBody.note_html
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/call/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call activity
      effect: destructive
      questions:
      - Can I remove a call that was logged by mistake?
      - What's the way to delete a call record?
      instructions:
      - text: Delete call activity {id}.
        slots:
          id: path.id
      - text: Remove the mistakenly logged call {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'