API Evangelist conversational phrasing for Close Custom Fields.shared API

# 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.shared API
  version: 1.0.0
extends: openapi/close-custom-fields-shared-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: 9
- target: $.paths['/custom_field/shared/'].get
  update:
    x-apievangelist-phrasing:
      intent: List shared custom fields
      effect: read
      questions:
      - Which custom fields are shared across leads, contacts and activities?
      - Can I limit which attributes come back when listing shared fields?
      instructions:
      - text: List all shared custom fields in our organization.
      - text: List shared custom fields returning only {fields}.
        slots:
          fields: query._fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shared custom field
      effect: write
      questions:
      - How do I create a custom field that can be reused on several object types?
      - Can one custom field be shared between leads and contacts?
      instructions:
      - text: Create a new shared custom field called Region.
      - text: Add a shared choices field we can attach to multiple object types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared custom field
      effect: read
      questions:
      - Where do I see the type and associations of one shared field?
      - What object types is a given shared custom field attached to?
      instructions:
      - text: Show shared custom field {id}.
        slots:
          id: path.id
      - text: Fetch the details of shared field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit a shared custom field
      effect: write
      questions:
      - Can I change the type of a shared custom field after creating it?
      - How do I update the choice options on a shared field?
      instructions:
      - text: Rename shared custom field {id}.
        slots:
          id: path.id
      - text: Update the choice options on shared field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shared custom field
      effect: destructive
      questions:
      - What happens to stored values when I delete a shared custom field?
      - Can I remove a shared field and all its associations at once?
      instructions:
      - text: Delete shared custom field {id} and all its associations.
        slots:
          id: path.id
      - text: Permanently remove shared field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/{scf_id}/association/'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a shared field to an object type
      effect: write
      questions:
      - How do I make a shared custom field available on contacts?
      - Which object types can a shared custom field be associated with?
      instructions:
      - text: Associate shared field {scf_id} with leads.
        slots:
          scf_id: path.scf_id
      - text: Attach shared custom field {scf_id} to a custom activity type.
        slots:
          scf_id: path.scf_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/{scf_id}/association/{object_type}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared field's object-type association
      effect: read
      questions:
      - Is a shared field required on a particular object type?
      - Where can I check how a shared field is associated with contacts?
      instructions:
      - text: Show the association of shared field {scf_id} with {object_type}.
        slots:
          scf_id: path.scf_id
          object_type: path.object_type
      - text: Fetch the {object_type} association for shared field {scf_id}.
        slots:
          scf_id: path.scf_id
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/{scf_id}/association/{object_type}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a shared field association's rules
      effect: write
      questions:
      - Can I make a shared field required only on leads?
      - How do I limit which roles can edit a shared field on one object type?
      instructions:
      - text: Make shared field {scf_id} required on {object_type}.
        slots:
          scf_id: path.scf_id
          object_type: path.object_type
      - text: Restrict editing of shared field {scf_id} on {object_type} to admins.
        slots:
          scf_id: path.scf_id
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/shared/{scf_id}/association/{object_type}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a shared field from an object type
      effect: destructive
      questions:
      - Are values lost when I disassociate a shared field from an object type?
      - How do I stop a shared field from appearing on opportunities?
      instructions:
      - text: Disassociate shared field {scf_id} from {object_type}.
        slots:
          scf_id: path.scf_id
          object_type: path.object_type
      - text: Remove shared field {scf_id} from the {object_type} object type.
        slots:
          scf_id: path.scf_id
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'