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 Smtp Configs API

Default IP pool, category, tags, and open and click tracking settings for messages submitted over SMTP with a given API key.

Bird Email Smtp Configs 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-smtp-configs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 13 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.

3 operations 2 paths 13 schemas 2 GET1 PATCH

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 Smtp Configs 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 3

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

email-smtp-configs 3

Default IP pool, category, tags, and open and click tracking settings for messages submitted over SMTP with a given API key.

GET
/v1/email/smtp/configs
List SMTP configs
listEmailSmtpConfigs 6 params → 200401403422429500
GET
/v1/email/smtp/configs/{api_key_id}
Get an SMTP config
getEmailSmtpConfig 1 param → 200401403404422429500
PATCH
/v1/email/smtp/configs/{api_key_id}
Update the SMTP config for an API key
updateEmailSmtpConfig 2 params body → 200400401403404422429500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ErrorBody (11 properties), EmailSmtpConfigUpdate (5 properties), NextAction (5 properties), _ListEnvelope (3 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
EmailSmtpConfig
NextAction
object
5 properties 2 required
Timestamps
object
2 properties 2 required
EmailSmtpConfigList
EmailSmtpConfigUpdate
object
Desired changes to the SMTP config for the key. A field you omit is left unchanged. If no config exists yet for this key, omitted fields take their documented…
5 properties
_ListEnvelopeWithTotal
APIKeyID
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
SortOrder
string
Sort direction, ascending or descending.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-email-smtp-configs-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 Smtp Configs 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.