# Bird API

**Canonical:** https://apis.io/apis/messagebird/bird-api/  
**Provider:** Messagebird — https://apis.io/providers/messagebird/  
**Base URL:** https://platform.bird.com  
**Documentation:** https://bird.com/docs/api

Bird API is one of 19 APIs that [Messagebird](https://apis.io/providers/messagebird/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Email, SMS, WhatsApp, Voice, and Messaging. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The current Bird platform API: one REST API for email, SMS, WhatsApp, verification, lookup and Realtime, plus workspaces, organizations, teams, sending domains, dedicated IPs, suppressions, contacts and audiences. 277 operations over 216 paths, described by a first-party OpenAPI 3.1 document Bird publishes at https://bird.com/openapi.json and generates its SDKs from. Bearer API keys prefixed bk_{region}_ or OAuth 2.0 access tokens from platform.bird.com; opt-in Idempotency-Key on every mutating request; IETF RateLimit response headers; a stable, documented error-code catalog; and Standard Webhooks event delivery.

## Operations (60 of 282)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/docs/search` | Get documentation search results |
| GET | `/v1/docs/pages` | Get a documentation page |
| GET | `/v1/workspace` | Get the current workspace |
| GET | `/v1/realtime/regions` | List Realtime regions |
| POST | `/v1/realtime/apps` | Create a Realtime app |
| GET | `/v1/realtime/apps` | List Realtime apps |
| GET | `/v1/realtime/apps/{realtime_app_id}` | Get a Realtime app |
| PATCH | `/v1/realtime/apps/{realtime_app_id}` | Update a Realtime app |
| DELETE | `/v1/realtime/apps/{realtime_app_id}` | Delete a Realtime app |
| POST | `/v1/realtime/apps/{realtime_app_id}/events` | Publish a Realtime event |
| POST | `/v1/realtime/apps/{realtime_app_id}/batch-events` | Publish a batch of Realtime events |
| GET | `/v1/realtime/apps/{realtime_app_id}/channels` | List Realtime channels |
| GET | `/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}` | Get a Realtime channel |
| GET | `/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}/members` | List members on a presence channel |
| POST | `/v1/realtime/apps/{realtime_app_id}/members/{member_id}/disconnect` | Disconnect a member |
| POST | `/v1/realtime/apps/{realtime_app_id}/members/{member_id}/events` | Send an event to a member |
| GET | `/v1/realtime/apps/{realtime_app_id}/keys` | List a Realtime app's keys |
| POST | `/v1/realtime/apps/{realtime_app_id}/keys` | Create a Realtime app key |
| POST | `/v1/realtime/apps/{realtime_app_id}/keys/{realtime_app_key_id}/revoke` | Revoke a Realtime app key |
| POST | `/v1/email/messages` | Create an email message |
| GET | `/v1/email/messages` | List messages |
| POST | `/v1/email/batches` | Create a batch of email messages |
| GET | `/v1/email/messages/{message_id}` | Get a message |
| POST | `/v1/email/messages/{message_id}/cancel` | Cancel a scheduled message |
| GET | `/v1/email/messages/{message_id}/recipients` | List recipients of a message |
| GET | `/v1/email/messages/{message_id}/events` | List events for a message |
| GET | `/v1/email/messages/{message_id}/content` | Get stored message content |
| GET | `/v1/email/messages/{message_id}/attachments/{attachment_id}` | Get a message attachment |
| POST | `/v1/email/broadcasts` | Create a broadcast |
| GET | `/v1/email/broadcasts` | List broadcasts |
| GET | `/v1/email/broadcasts/export` | Export broadcasts as CSV |
| GET | `/v1/email/broadcasts/{broadcast_id}` | Get a broadcast |
| PATCH | `/v1/email/broadcasts/{broadcast_id}` | Update a broadcast |
| DELETE | `/v1/email/broadcasts/{broadcast_id}` | Delete a broadcast |
| GET | `/v1/email/broadcasts/{broadcast_id}/counts` | Get a broadcast's audience counts |
| GET | `/v1/email/broadcasts/{broadcast_id}/send-quota` | Get how much of a broadcast the send allowance covers |
| GET | `/v1/email/broadcasts/{broadcast_id}/recipients` | List recipients of a broadcast |
| GET | `/v1/email/broadcasts/{broadcast_id}/recipients/export` | Export a broadcast's recipients as CSV |
| GET | `/v1/email/broadcasts/{broadcast_id}/events` | List events for a broadcast |
| GET | `/v1/email/broadcasts/{broadcast_id}/clicked-links` | List a broadcast's clicked links |
| POST | `/v1/email/broadcasts/{broadcast_id}/send` | Send a broadcast |
| POST | `/v1/email/broadcasts/{broadcast_id}/cancel` | Cancel a broadcast |
| POST | `/v1/contacts` | Create a contact |
| GET | `/v1/contacts` | List contacts |
| POST | `/v1/contacts/batch` | Create or update contacts in bulk |
| GET | `/v1/contacts/{contact_id}` | Get a contact |
| PATCH | `/v1/contacts/{contact_id}` | Update a contact |
| DELETE | `/v1/contacts/{contact_id}` | Delete a contact |
| GET | `/v1/contacts/{contact_id}/preferences` | List a contact's preferences |
| GET | `/v1/preferences` | List preferences |
| POST | `/v1/preferences` | Record a preference |
| GET | `/v1/preferences/{preference_id}` | Get a preference |
| DELETE | `/v1/preferences/{preference_id}` | Delete a preference |
| POST | `/v1/contact-properties` | Create a contact property |
| GET | `/v1/contact-properties` | List contact properties |
| GET | `/v1/contact-properties/{property_id}` | Get a contact property |
| PATCH | `/v1/contact-properties/{property_id}` | Update a contact property |
| POST | `/v1/contact-properties/{property_id}/archive` | Archive a contact property |
| POST | `/v1/contact-properties/{property_id}/unarchive` | Unarchive a contact property |
| POST | `/v1/audiences` | Create an audience |

…and 222 more operations. The page lists the first 250; the full set of 282 is in the OpenAPI linked below.

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/messagebird/refs/heads/main/openapi/messagebird-bird-api-openapi.yml
- **OpenAPI** — https://bird.com/openapi.json
- **OpenAPI** — https://bird.com/openapi.yaml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/messagebird/refs/heads/main/overlays/messagebird-bird-api-overlay.yaml
- **Documentation** — https://bird.com/docs
- **APIReference** — https://bird.com/docs/api
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/messagebird/refs/heads/main/asyncapi/messagebird-bird-webhooks.yml
- **ToolCrosswalk** — https://raw.githubusercontent.com/api-evangelist/messagebird/refs/heads/main/mcp/messagebird-tool-crosswalk.yml
- **MCPServer** — https://raw.githubusercontent.com/api-evangelist/messagebird/refs/heads/main/mcp/messagebird-mcp.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/messagebird/refs/heads/main/data-model/messagebird-data-model.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/messagebird/refs/heads/main/apis.yml

## Other Messagebird APIs (12)

- [messagebird Available Numbers API](https://apis.io/apis/messagebird/messagebird-available-numbers-api/)
- [messagebird Balance API](https://apis.io/apis/messagebird/messagebird-balance-api/)
- [messagebird Call Flows API](https://apis.io/apis/messagebird/messagebird-call-flows-api/)
- [messagebird Calls API](https://apis.io/apis/messagebird/messagebird-calls-api/)
- [messagebird Contacts API](https://apis.io/apis/messagebird/messagebird-contacts-api/)
- [messagebird Conversations API](https://apis.io/apis/messagebird/messagebird-conversations-api/)
- [messagebird Groups API](https://apis.io/apis/messagebird/messagebird-groups-api/)
- [messagebird HLR API](https://apis.io/apis/messagebird/messagebird-hlr-api/)
- [messagebird Legs API](https://apis.io/apis/messagebird/messagebird-legs-api/)
- [messagebird Lookup API](https://apis.io/apis/messagebird/messagebird-lookup-api/)
- [messagebird Messages API](https://apis.io/apis/messagebird/messagebird-messages-api/)
- [messagebird Purchased Numbers API](https://apis.io/apis/messagebird/messagebird-purchased-numbers-api/)

## Tags

Email, SMS, WhatsApp, Voice, Messaging, Verification, Lookup, Contacts, Webhook, Real-Time

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/messagebird/bird-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/messagebird/.