API Evangelist conversational phrasing for Live Direct Marketing Online Companies / Custom Fields API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Companies / Custom Fields API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-companies-custom-fields-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: 7
- target: $.paths['/api/companies/custom-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List company, contact or lead custom fields
      effect: read
      questions:
      - Which custom fields are defined on companies?
      - Can I list the custom field definitions for contacts or leads too?
      instructions:
      - text: List custom field definitions for entity {entity}.
        slots:
          entity: query.entity
      - text: Show the {entity} custom field setup.
        slots:
          entity: query.entity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/custom-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company custom field
      effect: write
      questions:
      - How do I add a new custom field to company records?
      - Can a company custom field be a dropdown with fixed options?
      instructions:
      - text: Create a {fieldType} company field labelled {label} with slug {slug}.
        slots:
          fieldType: requestBody.fieldType
          label: requestBody.label
          slug: requestBody.slug
      - text: Add a {fieldType} field {label} (slug {slug}) with options {options}.
        slots:
          fieldType: requestBody.fieldType
          label: requestBody.label
          slug: requestBody.slug
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/custom-fields/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder company custom fields
      effect: write
      questions:
      - How do I change the order company custom fields appear in?
      - Can I reorder company fields by passing their ids?
      instructions:
      - text: Reorder the company custom field definitions.
      - text: Set a new display order for company custom fields.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/custom-fields/{companyId}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's custom field values
      effect: read
      questions:
      - What custom field values are filled in for a particular company?
      - Can I read all custom data stored on one company?
      instructions:
      - text: Get custom field values for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show company {companyId}'s custom data.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/custom-fields/{companyId}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a company's custom field values
      effect: write
      questions:
      - How do I fill in several custom fields on a company at once?
      - Can I note the source of custom values I write to a company?
      instructions:
      - text: Set company {companyId}'s custom values to {values}.
        slots:
          companyId: path.companyId
          values: requestBody.values
      - text: Save custom values {values} on company {companyId} from source {source}.
        slots:
          values: requestBody.values
          companyId: path.companyId
          source: requestBody.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/custom-fields/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a company custom field definition
      effect: write
      questions:
      - How do I change the label or options of a company custom field?
      - Can I make an existing company field filterable or required?
      instructions:
      - text: Relabel company custom field {id} as {label}.
        slots:
          id: path.id
          label: requestBody.label
      - text: Update the options of company field {id} to {options}.
        slots:
          id: path.id
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/custom-fields/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company custom field definition
      effect: destructive
      questions:
      - How do I delete a company custom field?
      - Why does deleting a company field need an explicit confirmation?
      instructions:
      - text: Delete company custom field {id} with confirm={confirm}.
        slots:
          id: path.id
          confirm: query.confirm
      - text: Remove company field definition {id}, confirm {confirm}.
        slots:
          id: path.id
          confirm: query.confirm
      method: generated
      generated: '2026-10-01'