Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.email Threads API

4 actions 4 updates phrasing extends openapi/close-activities-email-threads-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/emailthread/'].get

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

$.paths['/activity/emailthread/{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.email Threads API
  version: 1.0.0
extends: openapi/close-activities-email-threads-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/emailthread/'].get
  update:
    x-apievangelist-phrasing:
      intent: List email conversations
      effect: read
      questions:
      - What email conversations have we had with a lead?
      - Can I list email threads grouped by subject for a contact?
      instructions:
      - text: List email threads for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show email conversations with contact {contact_id}.
        slots:
          contact_id: query.contact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/emailthread/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email thread
      effect: read
      questions:
      - What messages are in a particular email thread?
      - Can I fetch a single email conversation by id?
      instructions:
      - text: Fetch email thread {id}.
        slots:
          id: path.id
      - text: Show the conversation in email thread {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/emailthread/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email thread and its emails
      effect: destructive
      questions:
      - Does deleting an email thread also delete its emails?
      - Can I remove a whole email conversation from a lead?
      instructions:
      - text: Delete email thread {id} and all its emails.
        slots:
          id: path.id
      - text: Remove the email conversation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'