# 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 API
  version: 1.0.0
extends: openapi/zendesk-custom-objects-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: 6
- target: $.paths['/api/v2/custom_objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom objects
      effect: read
      questions:
      - Which custom objects have been defined in my account?
      - Can I see all custom object definitions that are not deleted?
      instructions:
      - text: List all the custom objects in the account.
      - text: Show my custom object definitions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom object
      effect: write
      questions:
      - How do I define a new custom object type such as Assets or Contracts?
      - Who is allowed to create custom objects?
      instructions:
      - text: Create a new custom object called Assets.
      - text: Define a custom object type to store contract data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a custom object
      effect: read
      questions:
      - Can I view the definition of a custom object by its key?
      - What properties are stored on one custom object?
      instructions:
      - text: Show the custom object with that key.
      - text: Fetch the definition of one custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object
      effect: destructive
      questions:
      - Can I permanently delete a custom object I no longer need?
      - Is deleting a custom object reversible?
      instructions:
      - text: Permanently delete the custom object with that key.
      - text: Remove the unused custom object definition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object
      effect: write
      questions:
      - Can I rename or change the description of a custom object?
      - Is the key of a custom object editable after creation?
      instructions:
      - text: Update the title and description of that custom object.
      - text: Change the properties of one existing custom object definition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/limits/object_limit'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the custom object limit
      effect: read
      questions:
      - How many custom objects can my account create in total?
      - How close am I to the maximum number of custom objects?
      instructions:
      - text: Show the current custom object count against the account limit.
      - text: Check how many more custom object types I can define.
      method: generated
      generated: '2026-09-26'