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 Email Messages API

Send emails to recipients you address explicitly in `to`, `cc`, and `bcc`. Use this for transactional sends (receipts, password resets, alerts) and for marketing sends where you already have the recipient addresses on hand. The same endpoint accepts every content type. Set `category` to control suppression policy.

Bird Email Messages 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 Email messages. 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 8 paths, and defines 34 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 8 paths 34 schemas 6 GET3 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 Email Messages 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 8 paths, the API surfaces 9 operations — 6 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

email-messages 9

Send emails to recipients you address explicitly in to, cc, and bcc. Use this for transactional sends (receipts, password resets, alerts) and for marketing sends where you already…

POST
/v1/email/messages
Create an email message
createEmailMessage 1 param body → 202400401402403413422429
GET
/v1/email/messages
List messages
listEmailMessages 10 params → 200401403422429500
POST
/v1/email/batches
Create a batch of email messages
createEmailMessageBatch 1 param body → 202400401402403413422429
GET
/v1/email/messages/{message_id}
Get a message
getEmailMessage 1 param → 200401403404422429500
POST
/v1/email/messages/{message_id}/cancel
Cancel a scheduled message
cancelEmailMessage 2 params → 204401403404409422429500
GET
/v1/email/messages/{message_id}/recipients
List recipients of a message
listEmailMessageRecipients 4 params → 200401403404422429500
GET
/v1/email/messages/{message_id}/events
List events for a message
listEmailMessageEvents 5 params → 200401403404422429500
GET
/v1/email/messages/{message_id}/content
Get stored message content
getEmailMessageContent 1 param → 200401403404410422425429
GET
/v1/email/messages/{message_id}/attachments/{attachment_id}
Get a message attachment
getEmailMessageAttachment 2 params → 200401403404410422425429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are EmailMessage (37 properties), EmailMessageSendRequest (19 properties), EmailEvent (18 properties), EmailRecipient (17 properties). Each schema is shown below with its type and property counts.

RecipientRole
string
Envelope position of a recipient on an outbound email event.
_ListEnvelope
object
3 properties 3 required
EmailRecipientList
EmailAttachmentID
string
EmailMessageBatchItem
object
8 properties 3 required
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
EmailMessageStatus
string
Aggregate delivery status of an email, derived from its recipients' states. In flight: - scheduled: The message is queued to send at a future time and has not…
EmailMessageBatchResponse
object
1 property 1 required
EmailAttachmentRef
object
Attachment metadata returned on API reads. Download the file during its retention window with GET /v1/email/messages/{messageid}/attachments/{attachmentid}.
6 properties 2 required
EmailMessageCategory
string
Content classification, which controls suppression policy: - marketing: Blocks on all suppression reasons. - transactional: Allows delivery through complaint a…
NextAction
object
5 properties 2 required
RecipientID
string
TemplateSlug
string
A template's slug: what you send it by, for example welcome-email. Email and SMS slugs stay fixed after creation. WhatsApp slugs can change only before the fir…
EmailMessageBatchRequest
object
Batch of email message send requests.
1 property 1 required
EmailTemplateID
string
EmailTemplateVersionID
string
EmailEventType
string
Type of an event in a message's per-recipient delivery timeline. - email.scheduled: We accepted a send scheduled for a future time. Fires once for each message…
EmailMessage
object
An email message, including a recipient's copy of a broadcast. broadcastid identifies the broadcast that sent the message and is absent for other sends. A broa…
37 properties 18 required
EmailAddressInput
A sender or recipient address. Accepts a plain email string (jane@acme.com), an RFC 5322 mailbox string with an embedded display name (Jane Doe ), or an object…
EmailEventList
EmailAddress
object
An email address with an optional display name.
2 properties 1 required
EmailTemplateSend
object
A reference to the template to send. Identify the template by its id or its slug, supplying exactly one of the two, and give the values for its variables in pa…
4 properties
EmailEvent
object
18 properties 4 required
EmailID
string
Error
object
1 property 1 required
Tag
object
Structured key/value label attached to a message or a call. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID); they surf…
2 properties 2 required
LanguageTag
string
A language tag in BCP-47 form, for example en or pt-BR.
EmailAttachment
object
A file attached to an email. Put the base64-encoded bytes in content and the recipient-facing name in filename. To show an image inline, set contentid and refe…
4 properties 2 required
EmailMessageContent
object
The body content of a sent email message, as delivered. A send that used a template stores the template's body, so these report it with the send's parameters s…
2 properties
EmailBroadcastID
string
EmailMessageSendRequest
object
19 properties 2 required
EmailRecipient
object
17 properties 7 required
EmailMessageList

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-email-messages-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 Email Messages 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.