Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Campaign API

3 actions 3 updates phrasing extends openapi/birdeye-campaign-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 3

$.info

$.paths['/v1/campaign/external/campaign-request-url'].post

$.paths['/v1/campaign/external/default-review-sources'].post

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 Campaign API
  version: 1.0.0
extends: openapi/birdeye-campaign-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: 2
- target: $.paths['/v1/campaign/external/campaign-request-url'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a review request link for a customer
      effect: write
      questions:
      - Can I generate a review request link for a specific customer?
      - Can the request link point to a survey or a specific template?
      instructions:
      - text: Fetch the review request URL for customer {customerId} at business {businessId}.
        slots:
          customerId: requestBody.customerId
          businessId: requestBody.businessId
      - text: Get a survey request link for customer {customerId} using survey {surveyId} at business {businessId}.
        slots:
          customerId: requestBody.customerId
          surveyId: requestBody.surveyId
          businessId: requestBody.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/campaign/external/default-review-sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply default review sources to a customer
      effect: write
      questions:
      - Can I set the default review sources a customer is asked to review on?
      - Is it possible to reset a customer's review sources back to the business defaults?
      instructions:
      - text: Set default review sources for customer {customerId} at business {businessId}.
        slots:
          customerId: requestBody.customerId
          businessId: requestBody.businessId
      - text: Apply the business default review sites to customer {customerId} in {businessId}.
        slots:
          customerId: requestBody.customerId
          businessId: requestBody.businessId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/birdeye-campaign-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.