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

Bird Domains API

Sending domain management and DNS verification.

Bird Domains API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 9 operations across 6 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

9 operations 6 paths 27 schemas 1 DELETE3 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Domains API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Domains 9

Sending domain management and DNS verification.

POST
/v1/email/domains
Create a sending domain
createDomain 1 param body → 201400401403409422429500
GET
/v1/email/domains
List sending domains
listDomains 7 params → 200401403422429500
PATCH
/v1/email/domains/{domain_id}
Update a sending domain
updateDomain 2 params body → 200400401403404409422429
GET
/v1/email/domains/{domain_id}
Get a sending domain
getDomain 1 param → 200401403404422429500
DELETE
/v1/email/domains/{domain_id}
Delete a sending domain
deleteDomain 2 params → 204401403404409422429500
GET
/v1/email/domains/{domain_id}/events
List domain events
listDomainEvents 6 params → 200401403404422429500
POST
/v1/email/domains/{domain_id}/verify
Verify a domain
verifyDomain 2 params → 200401403404422429500503
POST
/v1/email/domains/{domain_id}/tracking/release
Release link tracking configuration
releaseTrackingDomain 2 params → 200401403404422429500503
POST
/v1/email/domains/{domain_id}/dns-records/share
Share a domain's DNS records by email
shareDomainDnsRecords 2 params body → 204400401403404422429500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Domain (14 properties), ErrorBody (11 properties), DNSRecord (10 properties), DomainCapabilities (5 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
DomainList
DomainDKIM
object
Active DKIM signing configuration for the domain.
3 properties 3 required
WorkspaceID
string
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
ShareDomainDnsRequest
object
1 property 1 required
DomainCapability
object
4 properties 1 required
NextAction
object
5 properties 2 required
DomainEventID
string
Domain
object
14 properties 11 required
DomainEvent
object
5 properties 5 required
DomainCreate
object
5 properties 1 required
DomainCapabilities
object
5 properties 4 required
DomainDKIMConfig
object
DKIM signing configuration.
1 property
_ListEnvelopeWithTotal
DomainCapabilityPending
object
A staged configuration change awaiting DNS verification. The currently active configuration keeps serving until the staged one verifies, at which point it is p…
2 properties 2 required
Error
object
1 property 1 required
DomainID
string
DomainTrackingConfig
object
Tracking domain configuration for branded open and click tracking URLs. Provide only the name part; we add the sending domain automatically. A domain created w…
1 property 1 required
DomainEventList
DomainInboundConfig
object
Inbound (receiving) configuration. Enable inbound to receive email addressed to this domain. We return MX records to publish. After they verify, mail to any lo…
1 property 1 required
DomainUpdate
object
Partial update. settings changes apply immediately. Changes to returnpath, tracking, or dkim on a verified capability are staged. The current configuration kee…
5 properties
SortOrder
string
Sort direction, ascending or descending.
DomainReturnPathConfig
object
Return-path (bounce) domain configuration. The return-path domain receives bounce and complaint notifications for mail sent from this domain and is what mailbo…
1 property 1 required
DNSRecord
object
10 properties 8 required
DomainSettings
object
Per-domain behavior toggles. Changes apply immediately to new sends.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-domains-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Domains 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.