Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.emails API

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

$.paths['/activity/email/'].post

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

$.paths['/activity/email/{id}/'].put

$.paths['/activity/email/{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.emails API
  version: 1.0.0
extends: openapi/close-activities-emails-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/email/'].get
  update:
    x-apievangelist-phrasing:
      intent: List email activities
      effect: read
      questions:
      - What emails have been exchanged with a lead?
      - Can I list email messages sent by one rep within a date range?
      instructions:
      - text: List email activities for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show emails from user {user_id} created after {date_created__gte}.
        slots:
          user_id: query.user_id
          date_created__gte: query.date_created__gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/email/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create, draft, schedule or send an email
      effect: write
      questions:
      - How do I send an email to a lead through the API?
      - Can I schedule an email or just log one I already received?
      instructions:
      - text: Draft an email on lead {lead_id} with subject {subject}.
        slots:
          lead_id: requestBody.lead_id
          subject: requestBody.subject
      - text: Send an email to {to} on lead {lead_id} with status {status}.
        slots:
          to: requestBody.to
          lead_id: requestBody.lead_id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/email/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single email activity
      effect: read
      questions:
      - How do I pull the full body of one email message?
      - Can I see whether a specific email was opened?
      instructions:
      - text: Show email activity {id}.
        slots:
          id: path.id
      - text: Fetch the subject and body of email {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/email/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit or send a draft email
      effect: write
      questions:
      - Can I finish a draft email and then send it?
      - What's required when I change a draft's status to scheduled?
      instructions:
      - text: Change the subject of draft email {id} to {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      - text: Send draft email {id} by setting its status to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/email/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email activity
      effect: destructive
      questions:
      - Can I delete an email record from a lead's timeline?
      - How do I throw away a draft email?
      instructions:
      - text: Delete email activity {id}.
        slots:
          id: path.id
      - text: Discard the draft email {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'