Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Custom Activity Types API

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

$.paths['/custom_activity/'].post

$.paths['/custom_activity/{id}/'].get

$.paths['/custom_activity/{id}/'].put

$.paths['/custom_activity/{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 Custom Activity Types API
  version: 1.0.0
extends: openapi/close-custom-activity-types-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['/custom_activity/'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom activity types
      effect: read
      questions:
      - What custom activity types have we defined?
      - Can I see the fields on each custom activity type?
      instructions:
      - text: List our custom activity types.
      - text: Show every custom activity type with its fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_activity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom activity type
      effect: write
      questions:
      - How do I define a new kind of activity like a demo or site visit?
      - Do I have to create the activity type before adding its fields?
      instructions:
      - text: Create a custom activity type called Product Demo.
      - text: Define a new custom activity type for onsite visits.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_activity/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom activity type
      effect: read
      questions:
      - Which fields belong to a specific custom activity type?
      - How do I look up one custom activity type?
      instructions:
      - text: Show custom activity type {id}.
        slots:
          id: path.id
      - text: Fetch the fields of custom activity type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_activity/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom activity type
      effect: write
      questions:
      - Can I archive a custom activity type or rename it?
      - Is it possible to make an activity type creatable only through the API?
      instructions:
      - text: Rename custom activity type {id}.
        slots:
          id: path.id
      - text: Archive custom activity type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_activity/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom activity type
      effect: destructive
      questions:
      - Can I permanently delete an activity type we no longer track?
      - What's the way to remove a custom activity type?
      instructions:
      - text: Delete custom activity type {id}.
        slots:
          id: path.id
      - text: Permanently remove activity type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'