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 Sms Suppressions API

Sender and subscriber pairs that block SMS delivery.

Bird Sms Suppressions 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 sms-suppressions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

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

4 operations 2 paths 15 schemas 1 DELETE2 GET1 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 Sms Suppressions 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 4

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

sms-suppressions 4

Sender and subscriber pairs that block SMS delivery.

GET
/v1/sms/suppressions
List SMS suppressions
listSMSSuppressions 6 params → 200401403422429500
POST
/v1/sms/suppressions
Create an SMS suppression
createSMSSuppression 1 param body → 200201400401403422429500
GET
/v1/sms/suppressions/{suppression_id}
Get an SMS suppression
getSMSSuppression 1 param → 200401403404422429500
DELETE
/v1/sms/suppressions/{suppression_id}
Delete an SMS suppression
deleteSMSSuppression 2 params → 204401403404422429500503

Schemas 15

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

_ListEnvelope
object
3 properties 3 required
SMSSuppressionList
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
SMSSuppressionOrigin
string
How the opt-out reached us: - keyword: an inbound message from the subscriber. - dlrevent: a carrier delivery report. - apikey: an API call. - user: someone ac…
NextAction
object
5 properties 2 required
SMSSuppressionEndReason
string
What ended it: - keywordstart: the subscriber texting a start keyword to the same sender. - apikey: an API call. - user: someone acting in the dashboard. - car…
SMSSuppressionCoverage
string
Message categories blocked for this sender and subscriber. all blocks every category, including authentication and transactional messages. nontransactional blo…
SMSSuppressionReason
string
Reason this sender cannot message the subscriber: - keywordstop: The subscriber sent a stop keyword. A start keyword clears it. - carrieroptedout: The carrier…
Error
object
1 property 1 required
SMSSuppressionCreate
object
Stops one sender's messages to one subscriber. Both ends are required, because a suppression covers a sender-and-subscriber pair rather than a subscriber alone.
2 properties 2 required
SMSSuppressionID
string
SMSSuppressionReasonFilter
string
SMSSuppression
object
One period during which a sender's messages to a subscriber are stopped: when it started, what started it, and what ended it. A subscriber who opts out, opts b…
15 properties 10 required
SMSMessageID
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-sms-suppressions-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 Sms Suppressions 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.