Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.sms API

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

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

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

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

$.paths['/activity/sms/{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.sms API
  version: 1.0.0
extends: openapi/close-activities-sms-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/sms/'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS activities
      effect: read
      questions:
      - What text messages have been exchanged with a lead?
      - Can I list SMS and MMS messages sent by one user in a date range?
      instructions:
      - text: List SMS messages for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show texts for contact {contact_id}.
        slots:
          contact_id: query.contact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/sms/'].post
  update:
    x-apievangelist-phrasing:
      intent: Send, schedule or log an SMS
      effect: write
      questions:
      - How do I send a text message to a lead's contact?
      - Can I schedule an SMS for later or save it as a draft?
      - Is it possible to log an SMS I already received elsewhere?
      instructions:
      - text: 'Text {remote_phone} on lead {lead_id}: {text}'
        slots:
          remote_phone: requestBody.remote_phone
          lead_id: requestBody.lead_id
          text: requestBody.text
      - text: Create an SMS with status {status} for lead {lead_id} using template {template_id}.
        slots:
          status: requestBody.status
          lead_id: requestBody.lead_id
          template_id: requestBody.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/sms/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SMS activity
      effect: read
      questions:
      - What did a specific text message say?
      - Can I retrieve a single SMS and its attachments by id?
      instructions:
      - text: Fetch SMS {id}.
        slots:
          id: path.id
      - text: Show the text of SMS activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/sms/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit or send a draft SMS
      effect: write
      questions:
      - Can I send an SMS I saved as a draft?
      - Is it possible to change the scheduled time of a text?
      instructions:
      - text: Send draft SMS {id} now by setting status to outbox.
        slots:
          id: path.id
      - text: Change the text of draft SMS {id} to {text}.
        slots:
          id: path.id
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/sms/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SMS activity
      effect: destructive
      questions:
      - Can I delete a text message from a lead's history?
      - Which call removes an SMS activity?
      instructions:
      - text: Delete SMS {id}.
        slots:
          id: path.id
      - text: Remove SMS activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'