API Evangelist conversational phrasing for Zendesk Custom Objects Custom Object Fields API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Custom Objects Custom Object Fields API
  version: 1.0.0
extends: openapi/zendesk-custom-object-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['/api/v2/custom_objects/{custom_object_key}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields of a custom object
      effect: read
      questions:
      - What fields are defined on one of my custom objects?
      - Are deleted fields left out when listing custom object fields?
      instructions:
      - text: List the fields on this custom object.
      - text: Show all active fields of the Vehicle custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a custom object
      effect: write
      questions:
      - Can I add a lookup or dropdown field to a custom object?
      - Which field types are allowed on custom objects?
      instructions:
      - text: Add a text field called VIN to the Vehicle custom object.
      - text: Create a date field on this custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object field
      effect: read
      questions:
      - Can I fetch a custom object field by its key or id?
      - Where are one custom object field's settings?
      instructions:
      - text: Show this field of the custom object.
      - text: Get the VIN field definition on the Vehicle object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object field
      effect: destructive
      questions:
      - Can I remove a field from a custom object?
      - Is it possible to delete a standard custom object field?
      instructions:
      - text: Delete this field from the custom object.
      - text: Remove the unused VIN field from Vehicle.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object field
      effect: write
      questions:
      - Can I change a custom object field's title after creating it?
      - Which properties of a custom object field cannot be updated?
      instructions:
      - text: Update the title of this custom object field.
      - text: Edit the options of the dropdown field on the Vehicle object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/fields/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder a custom object's fields
      effect: write
      questions:
      - Can I set the display order of a custom object's fields?
      - Who is allowed to reorder custom object fields?
      instructions:
      - text: Reorder the fields on this custom object.
      - text: Put the VIN field first on the Vehicle object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/limits/field_limit'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a custom object's field limit
      effect: read
      questions:
      - How many more fields can I add to a custom object?
      - What is the field limit for a custom object and how many are used?
      instructions:
      - text: Show the field count and limit for this custom object.
      - text: Check how close the Vehicle object is to its field limit.
      method: generated
      generated: '2026-09-26'