# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Custom Fields API
  version: 1.0.0
extends: openapi/birdeye-custom-fields-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: 7
- target: $.paths['/v1/business/public/custom-fields/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field
      effect: write
      questions:
      - Can I define a new custom field such as a dropdown for my locations?
      - What field types and defaults can a new custom field have?
      instructions:
      - text: Create a custom field named {fieldName} of type {type}.
        slots:
          fieldName: requestBody.fieldName
          type: requestBody.type
      - text: Add a new custom field {fieldName} of type {type} with dropdown options {dropDownOptions}.
        slots:
          fieldName: requestBody.fieldName
          type: requestBody.type
          dropDownOptions: requestBody.dropDownOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/public/custom-fields/update/{fieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field definition
      effect: write
      questions:
      - Can I change the dropdown options or default value of an existing custom field?
      - Can I hide a custom field without deleting it?
      instructions:
      - text: Update custom field {fieldId} default value to {defaultValue}.
        slots:
          fieldId: path.fieldId
          defaultValue: requestBody.defaultValue
      - text: Hide custom field {fieldId}.
        slots:
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field for a location
      effect: read
      questions:
      - What's the definition and value of one custom field for a location?
      - Can I read a single custom field by its ID?
      instructions:
      - text: Get custom field {fieldId} for location {locationBizNumber}.
        slots:
          fieldId: path.fieldId
          locationBizNumber: path.locationBizNumber
      - text: Show custom field {fieldId} at location {locationBizNumber}.
        slots:
          fieldId: path.fieldId
          locationBizNumber: path.locationBizNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/public/custom-fields/getList?locationBizNumber={locationBizNumber}'].post
  update:
    x-apievangelist-phrasing:
      intent: List custom fields for a location
      effect: read
      questions:
      - Which custom fields exist for a location?
      - Can I search custom fields by name and sort them?
      instructions:
      - text: List custom fields for location {locationBizNumber}, page {page}, size {size}.
        slots:
          locationBizNumber: path.locationBizNumber
          page: requestBody.page
          size: requestBody.size
      - text: Search custom fields at {locationBizNumber} for {searchStr}, page {page}, size {size}.
        slots:
          locationBizNumber: path.locationBizNumber
          searchStr: requestBody.searchStr
          page: requestBody.page
          size: requestBody.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/public/custom-fields/delete/{fieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - Can I delete a custom field I no longer use?
      - Is there a call to remove a custom field definition by its ID?
      instructions:
      - text: Delete custom field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Remove the custom field definition {fieldId}.
        slots:
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/public/custom-fields/associate'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a custom field value on a location
      effect: write
      questions:
      - Can I set a custom field's value on a specific location?
      - How do I assign a value to a custom field for one business?
      instructions:
      - text: Set custom field {fieldId} to {fieldValue} on location {businessNumber}.
        slots:
          fieldId: requestBody.fieldId
          fieldValue: requestBody.fieldValue
          businessNumber: requestBody.businessNumber
      - text: Associate value {fieldValue} with field {fieldId} for business {businessNumber}.
        slots:
          fieldValue: requestBody.fieldValue
          fieldId: requestBody.fieldId
          businessNumber: requestBody.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/public/card'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a profile custom card
      effect: write
      questions:
      - Can I add a new custom card with an image and link to a business profile?
      - Can a newly created custom card be pinned to the top?
      instructions:
      - text: Create a custom card titled {title}.
        slots:
          title: requestBody.title
      - text: Create a profile custom card {title} linking to {clickURL} with image {imageURL}.
        slots:
          title: requestBody.title
          clickURL: requestBody.clickURL
          imageURL: requestBody.imageURL
      method: generated
      generated: '2026-09-26'