API Evangelist conversational phrasing for Zendesk Custom Object Records 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 Object Records API
  version: 1.0.0
extends: openapi/zendesk-custom-object-records-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: 13
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records/autocomplete'].get
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete custom object records by name
      effect: read
      questions:
      - Can I get record suggestions for a lookup field as an agent types a name?
      - Is it possible to narrow autocomplete results to records tied to a requester or organization?
      instructions:
      - text: Suggest custom object records whose field value matches {name}.
        slots:
          name: query.name
      - text: Autocomplete records named {name} for lookup field {field_id}.
        slots:
          name: query.name
          field_id: query.field_id
      - text: Autocomplete {name} records filtered for organization {organization_id}.
        slots:
          name: query.name
          organization_id: query.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a bulk job on custom object records
      effect: write
      questions:
      - Can I create, update or delete up to 100 custom object records in one background job?
      - Which bulk actions are supported for custom object records, such as delete by external ID?
      instructions:
      - text: Queue a bulk job that creates these custom object records.
      - text: Start a background job to upsert records by external ID for my custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records'].get
  update:
    x-apievangelist-phrasing:
      intent: List a custom object's records
      effect: read
      questions:
      - Where can I see all the undeleted records stored for one of my custom objects?
      - Can I list custom object records by a set of external IDs?
      instructions:
      - text: List the records of my custom object sorted by {sort}.
        slots:
          sort: query.sort
      - text: List custom object records with external IDs {external_ids}.
        slots:
          external_ids: query.filter[external_ids]
      - text: Page through the custom object's records, {size} per page.
        slots:
          size: query.page[size]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom object record
      effect: write
      questions:
      - How do I add one new record to a custom object I defined?
      - Why can't I supply a record name when autoincrement is enabled on the object?
      instructions:
      - text: Add a new record to my custom object with these field values.
      - text: Create a single custom object record following the object's definition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object record by external ID or name
      effect: destructive
      questions:
      - Can I delete a custom object record using its external ID instead of the Zendesk ID?
      - What must be enabled on the name field before deleting a record by name?
      instructions:
      - text: Delete the custom object record that has this external ID.
      - text: Remove the record identified by its unique name from my custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records'].patch
  update:
    x-apievangelist-phrasing:
      intent: Upsert a custom object record by external ID or name
      effect: write
      questions:
      - Can I update a custom object record if it exists for an external ID and create it otherwise?
      - Does an upsert by name change only the attributes I send?
      instructions:
      - text: Upsert the custom object record keyed by this external ID.
      - text: Create or update the record with this name on my custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a custom object record
      effect: read
      questions:
      - Can I fetch a single custom object record by its record ID?
      - What does one stored custom record look like when retrieved?
      instructions:
      - text: Show one custom object record by its Zendesk record ID.
      - text: Fetch the single record from my custom object with that ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object record by ID
      effect: destructive
      questions:
      - How do I delete one custom object record when I know its Zendesk record ID?
      - Can agents delete individual custom object records?
      instructions:
      - text: Delete the custom object record with that Zendesk record ID.
      - text: Remove a single record from my custom object by its ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object record
      effect: write
      questions:
      - Can I change the field values of an existing custom object record by its ID?
      - Where do the custom field values go when updating a record?
      instructions:
      - text: Update the fields of that custom object record by record ID.
      - text: Change one existing custom record's values nested under custom_object_fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a custom object's records
      effect: read
      questions:
      - How many records does one of my custom objects hold?
      - When was the record count for a custom object last refreshed?
      instructions:
      - text: Count the records in my custom object.
      - text: Tell me the total number of records for that custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a custom object's records
      effect: read
      questions:
      - Can I run a text search across the records of a custom object?
      - How are custom object record search results sorted?
      instructions:
      - text: Search my custom object's records for {query}.
        slots:
          query: query.query
      - text: Search custom records for {query} sorted by {sort}.
        slots:
          query: query.query
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/records/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter custom object records with comparison filters
      effect: read
      questions:
      - Can I filter custom object records with comparison conditions on their fields?
      - Is it possible to combine several field comparisons when searching records?
      instructions:
      - text: Filter my custom object records with these field comparisons plus the term {query}.
        slots:
          query: query.query
      - text: Run a filtered record search with comparison objects, {size} results per page.
        slots:
          size: query.page[size]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/limits/record_limit'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the custom object record limit
      effect: read
      questions:
      - How close is my account to its limit on custom object records?
      - What is the maximum number of custom object records I can store?
      instructions:
      - text: Show the current custom object record count against the account limit.
      - text: Check how many more custom records I can create before hitting the cap.
      method: generated
      generated: '2026-09-26'