Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Custom Field Schemas API

3 actions 3 updates phrasing extends openapi/close-custom-field-schemas-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 3

$.info
$.paths['/custom_field_schema/{object_type}/'].get
$.paths['/custom_field_schema/{object_type}/'].put

OpenAPI Overlay

Raw ↑ 
# 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 Field Schemas API
  version: 1.0.0
extends: openapi/close-custom-field-schemas-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: 2
- target: $.paths['/custom_field_schema/{object_type}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the custom field order for an object type
      effect: read
      questions:
      - In what order do custom fields appear on leads?
      - How do I see the custom field schema for contacts?
      instructions:
      - text: Show the custom field schema for {object_type}.
        slots:
          object_type: path.object_type
      - text: Get the field order for {object_type} custom fields.
        slots:
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field_schema/{object_type}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder custom fields for an object type
      effect: write
      questions:
      - Can I change the display order of custom fields?
      - What happens to fields I leave out when reordering a schema?
      instructions:
      - text: Reorder the {object_type} custom fields.
        slots:
          object_type: path.object_type
      - text: Update the custom field schema for {object_type} with the new order.
        slots:
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'