# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CRM Subpackage Custom Objects API
  version: 1.0.0
extends: openapi/merge-subpackage-customobjects-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: 5
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List records of a CRM custom object type
      effect: read
      questions:
      - Can I pull all records of a custom object type from a customer's CRM?
      - Which custom object records changed recently for one class?
      instructions:
      - text: List custom objects in class {class_id}.
        slots:
          class_id: path.custom_object_class_id
      - text: Show records of custom object class {class_id} modified after {modified_after}.
        slots:
          class_id: path.custom_object_class_id
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CRM custom object record
      effect: write
      questions:
      - How do I add a record to a custom object type in the CRM?
      - Can I write a custom object record asynchronously?
      instructions:
      - text: Create a custom object {record} in class {class_id}.
        slots:
          record: requestBody.model
          class_id: path.custom_object_class_id
      - text: Add record {record} to custom object class {class_id} asynchronously {run_async}.
        slots:
          record: requestBody.model
          class_id: path.custom_object_class_id
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM custom object record
      effect: read
      questions:
      - Can I fetch one custom object record by its ID?
      - What field values are stored on a single custom object record?
      instructions:
      - text: Get custom object {id} from class {class_id}.
        slots:
          id: path.id
          class_id: path.custom_object_class_id
      - text: Show me record {id} of custom object type {class_id}.
        slots:
          id: path.id
          class_id: path.custom_object_class_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to create a custom object record
      effect: read
      questions:
      - Which fields must I send to create a record of a custom object type?
      - What does the CRM accept when posting a custom object record?
      instructions:
      - text: Show creation fields for custom object class {class_id}.
        slots:
          class_id: path.custom_object_class_id
      - text: Get the create metadata for records in class {class_id}.
        slots:
          class_id: path.custom_object_class_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/custom-objects/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List field definitions across CRM custom objects
      effect: read
      questions:
      - What remote field classes exist on CRM custom objects?
      - Can I filter custom object field classes to only custom fields?
      instructions:
      - text: List custom object field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show custom object field classes that are common model fields {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      method: generated
      generated: '2026-09-26'