Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Field Enrichment API

2 actions 2 updates phrasing extends openapi/close-field-enrichment-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 2

$.info

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

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 Field Enrichment API
  version: 1.0.0
extends: openapi/close-field-enrichment-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: 1
- target: $.paths['/enrich_field/'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich a lead or contact field with AI
      effect: write
      questions:
      - Can AI fill in a custom field on a lead or contact for me?
      - Will AI enrichment overwrite a value that's already set?
      instructions:
      - text: Enrich field {field_id} on {object_type} {object_id} in organization {organization_id}.
        slots:
          field_id: requestBody.field_id
          object_type: requestBody.object_type
          object_id: requestBody.object_id
          organization_id: requestBody.organization_id
      - text: 'Use AI to fill field {field_id} on {object_type} {object_id} for org {organization_id}, overwriting existing: {overwrite_existing_value}.'
        slots:
          field_id: requestBody.field_id
          object_type: requestBody.object_type
          object_id: requestBody.object_id
          organization_id: requestBody.organization_id
          overwrite_existing_value: requestBody.overwrite_existing_value
      method: generated
      generated: '2026-09-26'