Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Custom Objects API

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

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

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

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

$.paths['/custom_object/{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 Objects API
  version: 1.0.0
extends: openapi/close-custom-objects-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_object/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a lead's custom object records
      effect: read
      questions:
      - Which custom object records are attached to a lead?
      - Can I list a lead's custom objects of one type only?
      instructions:
      - text: List custom objects on lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show custom objects of type {custom_object_type_id} on lead {lead_id}.
        slots:
          custom_object_type_id: query.custom_object_type_id
          lead_id: query.lead_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom object record
      effect: write
      questions:
      - How do I create a custom object record on a lead?
      - Can I set custom field values when creating a custom object?
      instructions:
      - text: Create a new custom object instance on this lead.
      - text: Add a custom object record with its custom field values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a custom object record
      effect: read
      questions:
      - What values does a specific custom object record hold?
      - Can I fetch one custom object instance by id?
      instructions:
      - text: Fetch custom object {id}.
        slots:
          id: path.id
      - text: Show the fields on custom object record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object record
      effect: write
      questions:
      - Can I rename a custom object record?
      - Is it possible to change custom field values on an existing custom object?
      instructions:
      - text: Rename custom object {id}.
        slots:
          id: path.id
      - text: Update the custom field values on custom object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object record
      effect: destructive
      questions:
      - Can I delete a custom object record from a lead?
      - Which call removes a custom object instance?
      instructions:
      - text: Delete custom object {id}.
        slots:
          id: path.id
      - text: Remove custom object record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'