# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CRM Custom Object Service API
  version: 1.0.0
extends: openapi/vendasta-crmcustomobjectservice-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/v1/crm/custom-object/bulk-delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete custom CRM objects
      effect: destructive
      questions:
      - Can I delete many custom CRM objects at once using a filter or search?
      - Is there a way to wipe all custom objects of one subtype in bulk?
      instructions:
      - text: Bulk delete custom objects of subtype {subtype} in {namespace}.
        slots:
          subtype: requestBody.crmObjectSubtype
          namespace: requestBody.namespace
      - text: Delete every custom object in {namespace} that matches search {search}.
        slots:
          namespace: requestBody.namespace
          search: requestBody.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom CRM object
      effect: write
      questions:
      - How do I add a new record of a custom object type to the CRM?
      - Can I create a custom object record with my own field values?
      instructions:
      - text: Create custom object {object} in namespace {namespace}.
        slots:
          object: requestBody.crmObject
          namespace: requestBody.namespace
      - text: 'Add a new custom object record to {namespace} with these fields: {object}.'
        slots:
          namespace: requestBody.namespace
          object: requestBody.crmObject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete one custom CRM object
      effect: destructive
      questions:
      - Can I delete a single custom object record by its ID?
      - What do I need to remove one custom object from the CRM?
      instructions:
      - text: Delete custom object {object_id} in {namespace}.
        slots:
          object_id: requestBody.crmObjectId
          namespace: requestBody.namespace
      - text: Remove the single custom object record {object_id}.
        slots:
          object_id: requestBody.crmObjectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/field-options'].post
  update:
    x-apievangelist-phrasing:
      intent: List options for a custom object field
      effect: read
      questions:
      - What values can a dropdown field on a custom object take?
      - Can I search the allowed options of one custom object field?
      instructions:
      - text: List the options for custom object field {field_id} in {namespace}.
        slots:
          field_id: requestBody.fieldId
          namespace: requestBody.namespace
      - text: Search custom object field {field_id} options for {term}.
        slots:
          field_id: requestBody.fieldId
          term: requestBody.searchTerm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/get-multi'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several custom objects by ID
      effect: read
      questions:
      - Can I retrieve a batch of custom objects when I already know their IDs?
      - Is it possible to limit which fields come back when fetching custom objects by ID?
      instructions:
      - text: Get custom objects {ids} from {namespace}.
        slots:
          ids: requestBody.crmObjectIds
          namespace: requestBody.namespace
      - text: Fetch custom objects {ids} returning only fields {mask}.
        slots:
          ids: requestBody.crmObjectIds
          mask: requestBody.fieldMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List and search custom CRM objects
      effect: read
      questions:
      - Which custom object records exist in my CRM?
      - Can I search and sort custom objects of a particular subtype?
      instructions:
      - text: List custom objects in {namespace}.
        slots:
          namespace: requestBody.namespace
      - text: Search custom objects of subtype {subtype} for {search}.
        slots:
          subtype: requestBody.crmObjectSubtype
          search: requestBody.search
      - text: List custom objects in {namespace} sorted by {sort}.
        slots:
          namespace: requestBody.namespace
          sort: requestBody.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/list-filters'].post
  update:
    x-apievangelist-phrasing:
      intent: List available filters for custom objects
      effect: read
      questions:
      - What filters can I apply when listing custom objects?
      - Can I get the custom object filter names in a specific language?
      instructions:
      - text: Show the filters available for custom objects in {namespace}.
        slots:
          namespace: requestBody.namespace
      - text: List custom object filters for subtype {subtype} in locale {locale}.
        slots:
          subtype: requestBody.crmObjectSubtype
          locale: requestBody.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a custom CRM object
      effect: write
      questions:
      - Can I change only certain fields on an existing custom object?
      - What does a field mask do when updating a custom object record?
      instructions:
      - text: Update custom object {object} in {namespace}.
        slots:
          object: requestBody.crmObject
          namespace: requestBody.namespace
      - text: Change only fields {mask} on custom object {object}.
        slots:
          mask: requestBody.fieldMask
          object: requestBody.crmObject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/custom-object/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a custom object before saving
      effect: read
      questions:
      - Can I check whether a custom object's data is valid without saving it?
      - Is there a dry run that tells me if a custom object record would be rejected?
      instructions:
      - text: Validate custom object {object} in {namespace} without saving it.
        slots:
          object: requestBody.crmObject
          namespace: requestBody.namespace
      - text: Check whether {object} passes custom object validation.
        slots:
          object: requestBody.crmObject
      method: generated
      generated: '2026-10-01'