# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk User Fields API
  version: 1.0.0
extends: openapi/zendesk-user-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: 10
- target: $.paths['/api/v2/user_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom user fields
      effect: read
      questions:
      - What custom fields exist on user profiles?
      - Are user fields returned in the order configured in Support?
      instructions:
      - text: List the custom user fields in my account.
      - text: Show every custom field on end-user profiles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom user field
      effect: write
      questions:
      - Can I add a dropdown or date field to user profiles?
      - Which field types can a new user field be?
      instructions:
      - text: Create a text user field called Employee ID.
      - text: Add a dropdown user field for customer tier.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/{user_field_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom user field
      effect: read
      questions:
      - Where can I see the settings of one user field?
      - Can agents read a single user field's definition?
      instructions:
      - text: Show the details of this user field.
      - text: Get the configuration of the customer tier user field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/{user_field_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom user field
      effect: write
      questions:
      - Can I change the dropdown choices of a user field?
      - What happens to existing options if I send a new list for a user field?
      instructions:
      - text: Update the title of this user field.
      - text: Replace the dropdown options on the customer tier user field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/{user_field_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom user field
      effect: destructive
      questions:
      - Can an admin remove a custom user field entirely?
      - Is deleting a user field restricted to admins?
      instructions:
      - text: Delete this custom user field.
      - text: Remove the unused Employee ID user field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/{user_field_id}/options'].get
  update:
    x-apievangelist-phrasing:
      intent: List options of a dropdown user field
      effect: read
      questions:
      - What choices does a dropdown user field offer?
      - Can I page through the options of a user dropdown field?
      instructions:
      - text: List the options of this dropdown user field.
      - text: Show the choices available in the customer tier field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/{user_field_id}/options'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a user field option
      effect: write
      questions:
      - Can I add a new choice to a user dropdown field?
      - Does sending an option id update the existing choice instead of adding one?
      instructions:
      - text: Add a Platinum option to the customer tier user field.
      - text: Rename an existing option on this dropdown user field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/{user_field_id}/options/{user_field_option_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one option of a user field
      effect: read
      questions:
      - Can I look up a single choice in a user dropdown field?
      - What name and value does one user field option have?
      instructions:
      - text: Show this option of the user field.
      - text: Get the details of the Gold option on the tier field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/{user_field_id}/options/{user_field_option_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an option from a user field
      effect: destructive
      questions:
      - Can I remove one choice from a user dropdown field?
      - Who is allowed to delete a user field option?
      instructions:
      - text: Delete this option from the user field.
      - text: Remove the Bronze choice from the customer tier field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/user_fields/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder custom user fields
      effect: write
      questions:
      - Can I change the order user fields appear on profiles?
      - Is reordering user fields an admin-only action?
      instructions:
      - text: Reorder the user fields into this sequence.
      - text: Move the customer tier user field to the top.
      method: generated
      generated: '2026-09-26'