# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CRM Field Schema Service API
  version: 1.0.0
extends: openapi/vendasta-crmfieldschemaservice-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: 5
- target: $.paths['/v1/crm/field-schema/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a CRM custom field
      effect: write
      questions:
      - Can I retire a CRM field I no longer use without creating a new one?
      - What's needed to archive a field on contacts or companies?
      instructions:
      - text: Archive field {fieldId} on {crmObjectType} records in namespace {namespace}.
        slots:
          fieldId: requestBody.fieldId
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
      - text: Retire CRM field {fieldId} from the {crmObjectType} object in {namespace}.
        slots:
          fieldId: requestBody.fieldId
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/field-schema/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CRM custom field
      effect: write
      questions:
      - How do I add a new custom field to CRM contacts or companies?
      - Can I define a new field on one subtype of a CRM object?
      instructions:
      - text: Create a new field {fieldSchema} on {crmObjectType} in namespace {namespace}.
        slots:
          fieldSchema: requestBody.fieldSchema
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
      - text: Add a custom field to the {crmObjectSubtype} subtype of {crmObjectType} in {namespace}.
        slots:
          crmObjectSubtype: requestBody.crmObjectSubtype
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/field-schema/get-multi'].post
  update:
    x-apievangelist-phrasing:
      intent: Get definitions of specific CRM fields
      effect: read
      questions:
      - What type and label does a given set of CRM field IDs have?
      - Can I fetch field definitions for known field IDs in a particular locale?
      instructions:
      - text: Get the schemas of fields {fieldId} on {crmObjectType} in {namespace}.
        slots:
          fieldId: requestBody.fieldId
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
      - text: Show field definitions {fieldId} for {crmObjectType} in {namespace} localized to {locale}.
        slots:
          fieldId: requestBody.fieldId
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
          locale: requestBody.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/field-schema/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List CRM field schemas
      effect: read
      questions:
      - Which fields exist on my CRM contacts, companies or opportunities?
      - Can I search all CRM field definitions by name?
      instructions:
      - text: List all CRM fields in namespace {namespace}.
        slots:
          namespace: requestBody.namespace
      - text: Search {crmObjectType} fields in {namespace} for {searchTerm}.
        slots:
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
          searchTerm: requestBody.searchTerm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/field-schema/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a CRM custom field definition
      effect: write
      questions:
      - Can I rename or change the settings of an existing CRM field?
      - Which parts of a field definition can I edit with a field mask?
      instructions:
      - text: Update the {crmObjectType} field schema in {namespace} to {fieldSchema}, changing only {fieldMask}.
        slots:
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
          fieldSchema: requestBody.fieldSchema
          fieldMask: requestBody.fieldMask
      - text: Edit an existing field on {crmObjectType} in {namespace} using definition {fieldSchema} and mask {fieldMask}.
        slots:
          crmObjectType: requestBody.crmObjectType
          namespace: requestBody.namespace
          fieldSchema: requestBody.fieldSchema
          fieldMask: requestBody.fieldMask
      method: generated
      generated: '2026-10-01'