Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.meetings API

6 actions 6 updates phrasing extends openapi/close-activities-meetings-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/meeting/'].get
$.paths['/activity/meeting/{id}/'].get
$.paths['/activity/meeting/{id}/'].put
$.paths['/activity/meeting/{id}/'].delete
$.paths['/activity/meeting/{id}/integration/'].post

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.meetings API
  version: 1.0.0
extends: openapi/close-activities-meetings-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/meeting/'].get
  update:
    x-apievangelist-phrasing:
      intent: List meeting activities
      effect: read
      questions:
      - What meetings have been logged with a given lead?
      - Can I list meetings a user had within a date range?
      instructions:
      - text: List meetings for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show meetings by user {user_id} since {since}.
        slots:
          user_id: query.user_id
          since: query.activity_at__gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/meeting/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a meeting and its transcript
      effect: read
      questions:
      - Can I get the transcript of a recorded meeting?
      - What notes and outcome are on a specific meeting?
      instructions:
      - text: Fetch meeting {id}.
        slots:
          id: path.id
      - text: Get meeting {id} including its transcripts.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/meeting/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a meeting's notes or outcome
      effect: write
      questions:
      - Can I add my own notes to a meeting after it happened?
      - Is it possible to set the outcome of a meeting?
      instructions:
      - text: Update the notes on meeting {id}.
        slots:
          id: path.id
      - text: Set the outcome of meeting {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/meeting/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a meeting activity
      effect: destructive
      questions:
      - Can I remove a meeting from a lead's activity feed?
      - Which call deletes a meeting activity?
      instructions:
      - text: Delete meeting {id}.
        slots:
          id: path.id
      - text: Remove meeting activity {id} from the lead.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/meeting/{id}/integration/'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach an app's integration tab to a meeting
      effect: write
      questions:
      - Can my OAuth app add its own tab to a meeting in the activity feed?
      - What happens if my integration posts to the same meeting twice?
      instructions:
      - text: Create or update my app's integration data on meeting {id}.
        slots:
          id: path.id
      - text: Push third-party meeting notes to meeting {id} as an integration tab.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'