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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bird

Bird Whatsapp Templates API

Browse the WhatsApp message templates available to your workspace, approved by Meta and ready to send.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bird Whatsapp 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 WhatsApp 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 38 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 38 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 Whatsapp 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.

whatsapp-templates 6

Browse the WhatsApp message templates available to your workspace, approved by Meta and ready to send.

GET
/v1/whatsapp/templates
List available message templates
listWhatsAppTemplates 8 params → 200401403422429500
GET
/v1/whatsapp/templates/{template_ref}
Get a message template
getWhatsAppTemplate 1 param → 200401403404422429500
GET
/v1/whatsapp/templates/{template_ref}/versions
List a template's versions
listWhatsAppTemplateVersions 4 params → 200401403404422429500
GET
/v1/whatsapp/templates/{template_ref}/versions/{version_id}
Get a template version
getWhatsAppTemplateVersion 2 params → 200401403404422429500
GET
/v1/whatsapp/templates/{template_ref}/versions/{version_id}/languages
List a version's languages
listWhatsAppTemplateVersionLanguages 2 params → 200401403404422429500
GET
/v1/whatsapp/templates/{template_ref}/versions/{version_id}/languages/{language}
Get a version's language
getWhatsAppTemplateVersionLanguage 3 params → 200401403404422429500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are WhatsAppTemplate (21 properties), WhatsAppTemplateLanguage (14 properties), ErrorBody (11 properties), WhatsAppTemplateComponent (8 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
WhatsAppTemplate
object
A message template: one identity holding a copy of the message per language. Each language is reviewed, priced and paused by Meta on its own, so the template's…
21 properties 19 required
WhatsAppTemplateID
string
TemplateScope
string
Whether the template is one of our built-in templates (system) or one your workspace created (workspace).
WhatsAppTemplateCard
object
One card in a carousel.
1 property 1 required
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
WhatsAppTemplateSubmissionError
object
Why the submission itself did not complete. Distinct from rejection, which is Meta refusing the content it was given.
2 properties 1 required
WhatsAppTemplateRevision
integer
A write counter, incremented every time the content it belongs to changes. It sits at 1 on content that has never been written through this API.
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
WhatsAppTemplateQualityScore
string
Meta's quality rating for one language of a template, derived from how recipients respond to messages sent from it. The red score is the leading indicator of a…
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…
WhatsAppTemplateVersionLanguage
object
One language's content in one version, and what that submission did with it.
4 properties 1 required
WhatsAppTemplateVersionID
string
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…
WhatsAppTemplateLanguageState
object
Where one language stands, without its content: content lives under a version, read that for it. An object rather than a bare status string, so detail beyond s…
5 properties
WhatsAppTemplateLanguage
object
One language of one version: its content, what the submission carrying it did with it, and everything Meta holds about it.
14 properties 6 required
WhatsAppTemplateComponent
object
8 properties 1 required
WhatsAppTemplateList
WhatsAppTemplateContentHash
string
A hash over the serialized components this API surfaces, prefixed with the algorithm that produced it (sha256:) so the algorithm can change without the field b…
WhatsAppTemplateExampleParameter
object
4 properties 1 required
WhatsAppTemplateQuality
object
Meta's quality rating for one language, with the rating it moved from and when it moved. Present only once Meta has rated the language, and only on the version…
3 properties 2 required
WhatsAppTemplateLanguageStatus
string
Language review and health status: - approved: Passed review and can be sent. - pending: Under review. - rejected: Failed review. - paused or disabled: Sending…
WhatsAppTemplateRejection
object
Why Meta refused a language's content, and what it says about fixing it. Present when status is rejected.
3 properties
WhatsAppTemplateRejectionCategory
string
Why Meta refused a language's content, in Meta's own vocabulary, lowercased. Read it with reason, which carries Meta's human-written detail, and recommendation…
Error
object
1 property 1 required
WhatsAppTemplateButton
object
6 properties 1 required
WhatsAppTemplateLanguageSummary
object
One language of a version without its content. Fetch the language itself for the content.
5 properties 3 required
WhatsAppTemplateVersionSummary
object
One version of a template, without its content. A version holds a full copy of every language it was submitted with. Listing versions therefore names the langu…
7 properties 5 required
LanguageTag
string
A language tag in BCP-47 form, for example en or pt-BR.
WhatsAppTemplateLanguageList
object
1 property 1 required
WhatsAppTemplateVersionList
WhatsAppTemplateVersion
object
One version of a template: the content of every language it holds, frozen when it was submitted, alongside what Meta made of each. A draft is a version too: a…
6 properties 5 required
WhatsAppTemplateCategory
string
Meta's content classification for a template. - authentication: delivers one-time passcodes. - utility: delivers transaction-triggered updates (receipts, order…
WhatsAppTemplateCardComponent
object
One content block inside a carousel card.
5 properties 1 required
WhatsAppTemplateParameterType
string
The kind of value a template parameter carries, which follows the block it fills. The text type is a plain string substituted into a placeholder. This includes…
UserID
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-whatsapp-templates-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
AE Profile APIs.io
Bird Phone Numbers API
AE Profile APIs.io
Bird Identity Verification API
AE Profile APIs.io
Bird Touchpoints API
AE Profile APIs.io
Bird Accounts API
AE Profile APIs.io
Bird FAQ API
AE Profile APIs.io
Bird Intent API
AE Profile APIs.io
Bird SMS Messaging API
AE Profile APIs.io
Bird Channels API
AE Profile APIs.io
Bird Contacts API
AE Profile APIs.io
Bird Conversations API
AE Profile APIs.io
Bird Legacy MessageBird API
AE Profile APIs.io
#WhatsApp Templates
← Back to B APIs
API Details
ID
bird:bird-whatsapp-templates-api
Base URL
https://api.bird.com
Docs
https://docs.bird.com/api
Provider
Bird
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bird-whatsapp-templates-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bird-whatsapp-templates-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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