Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Custom Fields.opportunity API

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

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

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

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

$.paths['/custom_field/opportunity/{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.opportunity API
  version: 1.0.0
extends: openapi/close-custom-fields-opportunity-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/opportunity/'].get
  update:
    x-apievangelist-phrasing:
      intent: List opportunity custom fields
      effect: read
      questions:
      - Which custom fields do our opportunities have?
      - Can I see every opportunity custom field?
      instructions:
      - text: List all opportunity custom fields.
      - text: Show {limit} opportunity custom fields.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/opportunity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an opportunity custom field
      effect: write
      questions:
      - How do I add a custom field to opportunities?
      - Can I create a dropdown field for deals?
      instructions:
      - text: Create a new opportunity custom field.
      - text: Add a choices field to opportunities for deal source.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/opportunity/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch an opportunity custom field
      effect: read
      questions:
      - What type is a specific opportunity custom field?
      - Can I retrieve one opportunity custom field by id?
      instructions:
      - text: Fetch opportunity custom field {id}.
        slots:
          id: path.id
      - text: Show the details of opportunity field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/opportunity/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an opportunity custom field
      effect: write
      questions:
      - Can I change the type of an opportunity custom field?
      - Is it possible to rename an opportunity field or edit its options?
      instructions:
      - text: Rename opportunity custom field {id}.
        slots:
          id: path.id
      - text: Change the type of opportunity field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/opportunity/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an opportunity custom field
      effect: destructive
      questions:
      - What happens to deal values when I delete an opportunity custom field?
      - Can I remove a custom field from opportunities?
      instructions:
      - text: Delete opportunity custom field {id}.
        slots:
          id: path.id
      - text: Remove opportunity field {id} and its values.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'