Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Custom Fields.lead API

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

$.paths['/custom_field/lead/'].post

$.paths['/custom_field/lead/{id}/'].get

$.paths['/custom_field/lead/{id}/'].put

$.paths['/custom_field/lead/{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 Fields.lead API
  version: 1.0.0
extends: openapi/close-custom-fields-lead-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_field/lead/'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead custom fields
      effect: read
      questions:
      - What custom fields do our leads have?
      - Can I list lead custom fields a page at a time?
      instructions:
      - text: List our lead custom fields.
      - text: Show {limit} lead custom fields.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/lead/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead custom field
      effect: write
      questions:
      - How do I add a new custom field to leads?
      - Can I create a dropdown-style field on leads?
      instructions:
      - text: Create a lead custom field called Industry.
      - text: Add a choices field to leads for company size.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/lead/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lead custom field
      effect: read
      questions:
      - What are the options of a specific lead custom field?
      - How do I look up one lead field by ID?
      instructions:
      - text: Show lead custom field {id}.
        slots:
          id: path.id
      - text: Fetch the settings of lead field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/lead/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a lead custom field
      effect: write
      questions:
      - Can I switch a lead field to accept multiple values?
      - How do I rename a lead custom field?
      instructions:
      - text: Rename lead custom field {id}.
        slots:
          id: path.id
      - text: Update the choices on lead field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/lead/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead custom field
      effect: destructive
      questions:
      - Does deleting a lead field remove its values from every lead?
      - How do I remove a lead custom field we don't use?
      instructions:
      - text: Delete lead custom field {id}.
        slots:
          id: path.id
      - text: Permanently remove lead field {id} and its values.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'