Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Custom Fields.contact API

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

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

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

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

$.paths['/custom_field/contact/{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.contact API
  version: 1.0.0
extends: openapi/close-custom-fields-contact-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/contact/'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact custom fields
      effect: read
      questions:
      - What custom fields exist on contacts?
      - Can I page through contact custom fields?
      instructions:
      - text: List our contact custom fields.
      - text: Show {limit} contact custom fields.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/contact/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact custom field
      effect: write
      questions:
      - How do I add a new custom field to contacts?
      - Can a contact field accept multiple values?
      instructions:
      - text: Create a contact custom field called LinkedIn URL.
      - text: Add a choices field to contacts for preferred language.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/contact/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact custom field
      effect: read
      questions:
      - What type is a particular contact custom field?
      - How do I look up one contact field's options?
      instructions:
      - text: Show contact custom field {id}.
        slots:
          id: path.id
      - text: Fetch the options of contact field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/contact/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a contact custom field
      effect: write
      questions:
      - Can I change a contact field's type after creating it?
      - How do I restrict who can edit a contact field?
      instructions:
      - text: Rename contact custom field {id}.
        slots:
          id: path.id
      - text: Update the choices on contact field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/contact/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact custom field
      effect: destructive
      questions:
      - Will deleting a contact field wipe values on existing contacts?
      - How do I get rid of a contact custom field?
      instructions:
      - text: Delete contact custom field {id}.
        slots:
          id: path.id
      - text: Permanently remove contact field {id} and its values.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'