Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Integration API

2 actions 2 updates phrasing extends openapi/birdeye-integration-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Birdeye's API. It is a proposal applied on top of the contract, not a document Birdeye publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/integrations/add/businessintegrationmapping'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Integration API
  version: 1.0.0
extends: openapi/birdeye-integration-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: 1
- target: $.paths['/v1/integrations/add/businessintegrationmapping'].put
  update:
    x-apievangelist-phrasing:
      intent: Map locations to an integration
      effect: write
      questions:
      - Can I map locations to an integration group?
      - Can I activate or deactivate an integration for a location?
      instructions:
      - text: Add location {businessNumber} to integration group {integrationGroupId} with active {active}.
        slots:
          businessNumber: requestBody.businessNumber
          integrationGroupId: requestBody.integrationGroupId
          active: requestBody.active
      - text: Map business {businessNumber} into integration {integrationGroupId}, active set to {active}.
        slots:
          businessNumber: requestBody.businessNumber
          integrationGroupId: requestBody.integrationGroupId
          active: requestBody.active
      method: generated
      generated: '2026-09-26'