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 Templates API

Create and publish multilingual workspace SMS templates and browse built-in templates. Published workspace versions preserve their language content; built-in versions reflect the current catalogue.

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

This API exposes 6 operations across 6 paths, and defines 32 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.

6 operations 6 paths 32 schemas 6 GET

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 Templates 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 6

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

sms-templates 6

Create and publish multilingual workspace SMS templates and browse built-in templates. Published workspace versions preserve their language content; built-in versions reflect the…

GET
/v1/sms/templates
List SMS templates
listSMSTemplates 10 params → 200401403422429500
GET
/v1/sms/templates/{template_ref}
Get an SMS template
getSMSTemplate 1 param → 200401403404422429500
GET
/v1/sms/templates/{template_ref}/versions
List an SMS template's versions
listSMSTemplateVersions 6 params → 200401403404422429500
GET
/v1/sms/templates/{template_ref}/versions/{version_id}
Get an SMS template version
getSMSTemplateVersion 2 params → 200401403404422429500
GET
/v1/sms/templates/{template_ref}/versions/{version_id}/languages
List an SMS template version's languages
listSMSTemplateVersionLanguages 2 params → 200401403404422429500
GET
/v1/sms/templates/{template_ref}/versions/{version_id}/languages/{language}
Get an SMS template version's language
getSMSTemplateVersionLanguage 3 params → 200401403404422429500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are SMSTemplate (20 properties), SMSTemplateSummary (17 properties), ErrorBody (11 properties), SMSTemplateVersion (10 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
SMSTemplateLanguageList
object
1 property 1 required
WorkspaceID
string
TemplateScope
string
Whether the template is one of our built-in templates (system) or one your workspace created (workspace).
ErrorDetail
object
2 properties 2 required
SMSTemplateText
string
SMS template text, limited to 16 KiB of UTF-8 source. Blank text can be saved in a draft but cannot be published. Workspace templates support scalar variables,…
ErrorBody
object
11 properties 6 required
SMSTemplate
object
One SMS template identity and its authoring state. Content and variables live on versions, so this resource stays shallow.
20 properties 20 required
SMSTemplateList
TemplateOnMissingLanguage
string
What a send or a preview does when it asks for a language the template cannot serve. fallback serves the closest match instead. It tries a broader form of the…
NextAction
object
5 properties 2 required
TemplateVariable
object
A single variable slot a template fills in from the values supplied when sending. The same shape on email, SMS and WhatsApp, so reading what a template needs w…
5 properties 4 required
SMSTemplateVersionSummary
object
One SMS template version without its text.
10 properties 10 required
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…
SMSTemplateVersionLanguage
object
One language's content and revision metadata within a version.
4 properties 4 required
TemplateStatus
string
Where the template stands as a whole. The same five states on every channel. - draft: nothing has ever gone live. - pending: nothing is live and at least one l…
SMSTemplateLanguageState
object
Whether a language is live and whether its draft has unpublished changes.
2 properties 1 required
SMSTemplateLanguage
object
One language's full SMS template text and revision metadata.
5 properties 5 required
Error
object
1 property 1 required
SMSTemplateContentHash
string
A fingerprint of SMS template text, prefixed with its algorithm. Compare it within this API version to identify the exact source without transferring it.
SMSTemplateSummary
object
An SMS template without content or draft concurrency settings.
17 properties 17 required
SMSTemplateSortField
string
Field to sort SMS templates and their versions by.
SMSTemplateLanguageSummary
object
One language of an SMS template version without its text.
4 properties 4 required
LanguageTag
string
A language tag in BCP-47 form, for example en or pt-BR.
SMSTemplateVersionStatus
string
Whether the version is the editable draft or published. Published workspace versions are immutable and remain published after a later version goes live. A buil…
SMSTemplateID
string
SMSTemplateCategory
string
Why messages use this template. Use authentication for one-time codes, marketing for promotions, and transactional for service messages.
SortOrder
string
Sort direction, ascending or descending.
SMSTemplateVersion
object
One SMS template version with its content. A workspace template keeps one editable draft and immutable published versions. A built-in template exposes its curr…
10 properties 10 required
SMSTemplateVersionID
string
TemplateLanguageStatus
string
Status of one template language on channels without third-party review. - draft: it has never been published. - live: it is available to sends. - superseded: a…
SMSTemplateVersionList

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-sms-templates-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 Templates 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.