# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Custom Fields API
  version: 1.0.0
extends: openapi/cvent-custom-fields-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: 7
- target: $.paths['/custom-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom fields in the account
      effect: read
      questions:
      - What custom fields are defined for contacts in my account?
      - Why does listing custom fields require a filter, like a category?
      instructions:
      - text: List custom fields matching {filter}.
        slots:
          filter: query.filter
      - text: Show custom fields filtered by {filter} changed after {after}.
        slots:
          filter: query.filter
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field
      effect: write
      questions:
      - How do I add a new custom question field to my account?
      - Can I make a new custom field required with help text?
      instructions:
      - text: Create a {type} custom field {name} with code {code} in category {category}.
        slots:
          type: requestBody.type
          name: requestBody.name
          code: requestBody.code
          category: requestBody.category
      - text: Add a new custom field {name} with help text {helpText}.
        slots:
          name: requestBody.name
          helpText: requestBody.helpText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field
      effect: read
      questions:
      - What type and choices does a specific custom field have?
      - Can I look up a custom field by ID?
      instructions:
      - text: Get custom field {customFieldId}.
        slots:
          customFieldId: path.customFieldId
      - text: Show the definition of custom field {customFieldId}.
        slots:
          customFieldId: path.customFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field
      effect: write
      questions:
      - Can I rename an existing custom field?
      - Is it possible to deactivate a custom field without deleting it?
      instructions:
      - text: Rename custom field {customFieldId} to {name}.
        slots:
          customFieldId: path.customFieldId
          name: requestBody.name
      - text: Set existing custom field {customFieldId} active flag to {active}.
        slots:
          customFieldId: path.customFieldId
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}/advanced-logic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a field's choices depend on another field
      effect: write
      questions:
      - How do I show different choices depending on the answer to another field?
      - Can I link a custom field to a source field for cascading options?
      instructions:
      - text: Link custom field {customFieldId} to source field {sourceCustomFieldId} for advanced logic.
        slots:
          customFieldId: path.customFieldId
          sourceCustomFieldId: requestBody.sourceCustomFieldId
      - text: Set advanced logic on field {customFieldId} using source choices {sourceChoices}.
        slots:
          customFieldId: path.customFieldId
          sourceChoices: requestBody.sourceChoices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}/translations'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field's existing translation
      effect: write
      questions:
      - Can I fix the French translation already on a custom field?
      - Is it possible to change a translation I added to a field earlier?
      instructions:
      - text: Update the {language} translation of custom field {customFieldId} to {translation}.
        slots:
          language: requestBody.language
          customFieldId: path.customFieldId
          translation: requestBody.translation
      - text: Correct existing {language} wording on field {customFieldId}.
        slots:
          language: requestBody.language
          customFieldId: path.customFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}/translations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a translation to a custom field
      effect: write
      questions:
      - How do I translate a custom field into another language?
      - Can I add a Spanish version of a custom field's text?
      instructions:
      - text: Add a {language} translation {translation} to custom field {customFieldId}.
        slots:
          language: requestBody.language
          translation: requestBody.translation
          customFieldId: path.customFieldId
      - text: Create a new translation in {language} for field {customFieldId}.
        slots:
          language: requestBody.language
          customFieldId: path.customFieldId
      method: generated
      generated: '2026-09-26'