Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.custom Activities API

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

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

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

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

$.paths['/activity/custom/{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.custom Activities API
  version: 1.0.0
extends: openapi/close-activities-custom-activities-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/custom/'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom activity records
      effect: read
      questions:
      - Which custom activities have been logged on a particular lead?
      - Can I filter custom activities by their custom activity type?
      instructions:
      - text: List custom activities for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show all custom activities of type {custom_activity_type_id}.
        slots:
          custom_activity_type_id: query.custom_activity_type_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/custom/'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a custom activity on a lead
      effect: write
      questions:
      - How do I record a custom activity, like a demo form, on a lead?
      - Can I save a custom activity as a draft without filling every required field?
      instructions:
      - text: Log a custom activity of type {custom_activity_type_id} on lead {lead_id}.
        slots:
          custom_activity_type_id: requestBody.custom_activity_type_id
          lead_id: requestBody.lead_id
      - text: Create a draft {custom_activity_type_id} activity on lead {lead_id} with status {status}.
        slots:
          custom_activity_type_id: requestBody.custom_activity_type_id
          lead_id: requestBody.lead_id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/custom/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom activity record
      effect: read
      questions:
      - What custom field values were recorded on a specific custom activity?
      - Can I fetch a single custom activity instance by id?
      instructions:
      - text: Fetch custom activity {id}.
        slots:
          id: path.id
      - text: Show the custom field values on custom activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/custom/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or publish a custom activity
      effect: write
      questions:
      - Can I move a custom activity from draft to published?
      - Is it possible to pin a custom activity to the top of the lead feed?
      instructions:
      - text: Set custom activity {id} to status {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Pin custom activity {id} on the lead.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/custom/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom activity record
      effect: destructive
      questions:
      - Can I remove a custom activity that was logged by mistake?
      - Which call deletes a single custom activity instance?
      instructions:
      - text: Delete custom activity {id}.
        slots:
          id: path.id
      - text: Remove custom activity record {id} from the lead.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'