# 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-event-cloud-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, events or sessions in my account?
      - Why does listing custom fields require a filter, and what can I filter on?
      instructions:
      - text: List custom fields matching {filter}.
        slots:
          filter: query.filter
      - text: Show custom fields for filter {filter}, {limit} per page.
        slots:
          filter: query.filter
          limit: query.limit
      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 named {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}): {required}.'
        slots:
          name: requestBody.name
          code: requestBody.code
          required: requestBody.required
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field
      effect: read
      questions:
      - What type and choices does a particular custom field have?
      - How do I look up one 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:
      - How do I rename or deactivate an existing custom field?
      - Can I change the help text shown for a custom field?
      instructions:
      - text: Rename existing custom field {customFieldId} to {name}.
        slots:
          customFieldId: path.customFieldId
          name: requestBody.name
      - text: Set custom field {customFieldId} active status 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 conditional display logic on a custom field
      effect: write
      questions:
      - How do I show a custom field only when another field has a certain answer?
      - Can I link a custom field's visibility to a source custom field?
      instructions:
      - text: Make custom field {customFieldId} depend on source field {sourceCustomFieldId}.
        slots:
          customFieldId: path.customFieldId
          sourceCustomFieldId: requestBody.sourceCustomFieldId
      - text: Show field {customFieldId} only when source field {sourceCustomFieldId} has choices {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:
      - How do I fix an existing translation of a custom field label?
      - Can I change the French text already saved for a custom field?
      instructions:
      - text: Update the existing {language} translation of custom field {customFieldId} to {translation}.
        slots:
          language: requestBody.language
          customFieldId: path.customFieldId
          translation: requestBody.translation
      - text: Replace custom field {customFieldId}'s saved {language} text.
        slots:
          customFieldId: path.customFieldId
          language: requestBody.language
      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 translation for a custom field in a new language?
      - Can I localize a custom field for attendees who register in Spanish?
      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-language translation for custom field {customFieldId} in {language}.
        slots:
          customFieldId: path.customFieldId
          language: requestBody.language
      method: generated
      generated: '2026-09-26'