How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Birdeye Contact V2 API

Easily manage contacts across multiple locations using enhanced Contact APIs, featuring built-in support for communication preference flags.

Birdeye Contact V2 API is one of 27 APIs that Birdeye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contact V2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 5 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.birdeye.com.

5 operations 5 paths 0 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.birdeye.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Birdeye Contact V2 API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKey). By default, every request must be authenticated.

  • apiKey — Partner specific API key provided by Birdeye for data exchange.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Contact V2 5

Easily manage contacts across multiple locations using enhanced Contact APIs, featuring built-in support for communication preference flags.

POST
/v1/contact/external/preferences/saveCustomer
Upsert Contact
upsert-contact body → 200
POST
/v1/contact/external/preferences/getCustomer
Retrieve Contact
retrieve-contact body → 200
POST
/v1/contact/external/preferences/checkin
Customer Checkin
customer-checkin body → 200
POST
/v1/contact/external/preferences/change-permission
Update Communication Preferences
update-communication-preferences body → 200
POST
/v1/contact/external/preferences/update-feed
Retrieve Opted-Out Contacts
retrieve-opted-out-contacts body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

birdeye-contact-v2-api-openapi.yml Raw ↑

Other APIs Birdeye publishes across the network.

Birdeye Aggregation API
Birdeye Business API
Birdeye Business Media API
Birdeye Campaign API
Birdeye Competitor AI API
Birdeye Competitor API
Birdeye Contact API
Birdeye Conversation API
Birdeye Custom Fields API
Birdeye Employee API
Birdeye FAQ API
Birdeye GMB Products API
Where this information came from

This is an independent, third-party profile of Birdeye Contact V2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.