# 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-registration-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 exist for contacts or events in my account?
      - Do I have to supply a filter to list custom fields?
      instructions:
      - text: List custom fields matching {filter}.
        slots:
          filter: query.filter
      - text: Show up to {limit} custom fields filtered by {filter}.
        slots:
          limit: query.limit
          filter: query.filter
      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 field to capture extra data?
      - Can I make a new custom field required or a consent field?
      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 required custom field {name} (code {code}) with help text {helpText}.
        slots:
          name: requestBody.name
          code: requestBody.code
          helpText: requestBody.helpText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field's definition
      effect: read
      questions:
      - What type and choices does a particular custom field have?
      - Can I look up a custom field by its 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 or deactivate an existing custom field?
      - Is it possible to change help text on a custom field that already exists?
      instructions:
      - text: Rename custom field {customFieldId} to {name}.
        slots:
          customFieldId: path.customFieldId
          name: requestBody.name
      - text: Set the active flag of existing custom field {customFieldId} 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: Set advanced logic between custom fields
      effect: write
      questions:
      - Can the choices in one custom field depend on the answer to another?
      - How do I link a custom field to a source field for dependent choices?
      instructions:
      - text: Make custom field {customFieldId} depend on source field {sourceCustomFieldId}.
        slots:
          customFieldId: path.customFieldId
          sourceCustomFieldId: requestBody.sourceCustomFieldId
      - text: Link field {customFieldId} to source {sourceCustomFieldId} with choice mapping {sourceChoices}.
        slots:
          customFieldId: path.customFieldId
          sourceCustomFieldId: requestBody.sourceCustomFieldId
          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 translation
      effect: write
      questions:
      - Can I correct an existing translation of a custom field?
      - How do I change the French wording of a custom field that's already translated?
      instructions:
      - text: Update the {language} translation of custom field {customFieldId} to {translation}.
        slots:
          language: requestBody.language
          customFieldId: path.customFieldId
          translation: requestBody.translation
      - text: Replace the existing {language} text on custom field {customFieldId} with {translation}.
        slots:
          language: requestBody.language
          customFieldId: path.customFieldId
          translation: requestBody.translation
      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 add a new language translation to a custom field?
      - Can a custom field be shown in another language to registrants?
      instructions:
      - text: Add a {language} translation {translation} to custom field {customFieldId}.
        slots:
          language: requestBody.language
          translation: requestBody.translation
          customFieldId: path.customFieldId
      - text: Create a first-time {language} version of custom field {customFieldId} reading {translation}.
        slots:
          language: requestBody.language
          customFieldId: path.customFieldId
          translation: requestBody.translation
      method: generated
      generated: '2026-09-26'