Bird Email 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 Email Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
18 operations
across 11 paths,
and defines 60 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.
The identity and technical contract details declared by the specification.
_ListEnvelope
object
3 properties
3 required
ErrorDetail
object
2 properties
2 required
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…
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
EmailTemplateLanguage
object
One language of a template version: its content plus the identity a concurrent-edit check needs. Reading a language returns everything you need to edit it and…
7 properties
4 required
EmailTemplateRollback
object
Parameters for rolling a template back to an earlier published version. Rolling back also replaces the draft with that version's content, so you have to pass r…
1 property
1 required
EmailTemplateSubmitProblem
object
One problem found while checking whether a version can be submitted.
4 properties
2 required
EmailTemplateLanguageSummary
object
One language of a template version, without its content: enough to list what a version holds and how big each language is. Read a single language to get its co…
6 properties
2 required
EmailTemplateLanguageUpsert
object
Content to save for one language, replacing whatever that language held. Send every field you want the language to keep: a field you omit is cleared, which is…
5 properties
1 required
EmailTemplateVersionStatus
string
Whether this version is still being edited or has been published. It records the version's publication history: a version that a later one replaced stays publi…
ErrorBody
object
11 properties
6 required
EmailTemplateSource
string
The authoring format the template is written in, fixed at creation. html is finished markup you provide, optionally personalized with Liquid.
EmailTemplateBroadcastList
EmailClientFamily
string
Which mail client a finding applies to. A finding's message names at most Apple Mail, Gmail, Outlook, and Yahoo; its unsupportedclients and partialclients name…
EmailTemplateBroadcastSummary
object
One broadcast that blocks deleting this template.
4 properties
3 required
EmailTemplateVersionID
string
EmailTemplateSubmit
object
Options for a submit. Every field here is optional, so an empty request body submits the draft exactly as it stands.
3 properties
EmailTemplateLanguageList
object
1 property
1 required
EmailTemplateSummary
object
20 properties
20 required
EmailClientPlatform
string
Which build of a client family a finding applies to. A family can support a feature in one build and not another, so Gmail on iOS is tracked separately from Gm…
EmailCompatibilityFinding
object
One pattern in the HTML that mail clients remove, ignore, or render inconsistently.
12 properties
12 required
EmailTemplateUpdate
object
Partial update of a template's metadata and draft settings. Only the fields you send are changed. The rest are left as-is. Include the draft revision you last…
6 properties
1 required
EmailTemplateLanguageState
object
Where one of the template's languages stands: whether sends are using it, and whether its draft contains an unpublished edit.
2 properties
1 required
EmailTemplateDuplicate
object
Optional parameters when duplicating an email template. The body may be omitted entirely to accept the defaults.
1 property
TemplateScope
string
Whether the template is one of our built-in templates (system) or one your workspace created (workspace).
NextAction
object
5 properties
2 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…
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…
EmailCompatibilitySeverity
string
What a finding costs you. - problem: the pattern does nothing at all. The client removes the markup, never loads the stylesheet carrying it, or will not operat…
EmailTemplatePreviewRequest
object
Sample values and options for rendering a template preview. Omit the body entirely to preview the current draft: bird.contact. tokens then fill from stand-in v…
5 properties
EmailTemplateLanguageContent
object
One language's content for an email template. Each language carries its own subject, preview text and bodies, so a translation can differ in wording and length…
4 properties
EmailTemplateSourceWrite
string
The authoring format to create the template in. html is finished markup you provide, optionally personalized with Liquid; a format the API cannot author yet is…
EmailTemplateThemeFilter
string
Filter by the visual theme a built-in template is designed in. Only built-in system templates have a theme, so naming one returns built-ins alone.
EmailTemplateRef
string
The template this call addressed, as its id, even when you addressed it by slug. Send it back as templateref on a follow-up call.
EmailTemplatePreview
object
A rendered preview of an email template: its subject, HTML, and plain-text bodies with the supplied sample values filled in, ready to display.
7 properties
7 required
EmailTemplateSubmitResult
object
The outcome of a submit. This has the same shape whether the submit was a validation run or a real one, so you can read valid and version the same way either t…
7 properties
6 required
EmailTemplateVersion
object
11 properties
8 required
EmailTemplateLanguageSaved
object
The identity, revision counters, and fingerprint of a saved language. The response does not include its content; read the language to retrieve it.
10 properties
7 required
EmailCompatibilityRuleID
string
Which rule produced a finding. - htmlscript: a tag. - htmleventhandlers: a JavaScript event-handler attribute such as onclick. - htmlembeddedcontent: an , , or…
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…
EmailTemplatePreviewContent
object
Content to render instead of the template's stored draft. Give it the subject and bodies you have in hand and they are rendered exactly as the draft would be,…
4 properties
EmailTemplateCreate
object
Parameters for creating an email template and its initial draft.
9 properties
3 required
EmailCompatibilityReportSeverity
string
The worst severity across every finding the response was computed from, which is the authoritative reading: a response that caps how many findings it lists sti…
Actor
object
3 properties
2 required
EmailTemplateDraftRevision
integer
The draft revision you last read (from the template's revision field). A stale value returns a conflict so you can reload and retry.
Error
object
1 property
1 required
LanguageTag
string
A language tag in BCP-47 form, for example en or pt-BR.
EmailTemplateLanguageUpdate
object
A partial edit to one language: send only the fields you are changing, and the rest keep their current values. The language must already exist. Create it by sa…
5 properties
EmailBroadcastStatus
string
Where the broadcast itself has got to. This is separate from what happened to individual recipients, which the broadcast's own sentcount, deliveredcount, bounc…
EmailTemplateVersionSummary
object
One version of a template, without its content. Version history lists every version a template has ever had, and each one has a full copy of the content in eve…
11 properties
8 required
EmailTemplateCategory
string
Whether the template is for transactional email or marketing email.
EmailTemplateTheme
string
The visual theme a built-in template is designed in. Each of the catalog's five themes ships its own set of eight emails, and the sets overlap only partly, so…
EmailTemplate
object
22 properties
22 required
EmailClientSupport
object
One mail client family a finding applies to, and which of that family's platforms.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bird publishes across the network.
