Get an SMS template
GET
/v1/sms/templates/{template_ref}
curl -X GET "https://us1.platform.bird.com/v1/sms/templates/{template_ref}" \
-H "Authorization: Bearer $TOKEN"Returns a single SMS template by its alias or id.
Parameter
template_ref
string
The template's alias or id.
Antwort-Payload
id
string
erforderlich
Unique identifier for the template.
name
string
erforderlich
Human-readable description of what the template is for.
alias
string
erforderlich
The template's stable handle. Pass it (or the id) as the template reference when sending.
scope
string
erforderlich
Whether the template is a built-in Bird template (system) or one your workspace authored (workspace).
category
object
erforderlich
Content classification applied to messages sent from this template.
body
string
erforderlich
The template body in its default language, shown for preview.
variables
array of object
erforderlich
The typed slots this template fills in from the values you supply when sending.
Untergeordnete Attribute anzeigen
variables.key
string
erforderlich
The parameters key this slot is filled with.
variables.type
string
erforderlich
The value type this slot accepts. Open enum — treat any unrecognized value as a future type rather than an error. SMS templates use the typed slots (code, amount, …); email templates use text.
variables.required
boolean
erforderlich
Whether the slot must be supplied when sending. Advisory for email templates, where a missing value renders as empty rather than rejecting the send.
variables.constraint
string
erforderlich
A human-readable description of the accepted values.
available_locales
array of string
erforderlich
The languages this template is available in, as BCP-47 tags.
status
string
erforderlich
The template's lifecycle state. Built-in templates are always active.
draft_version_id
nullable string
erforderlich
The current editable draft version. Always null today — SMS templates are not yet versioned; present for parity with email templates.
published_version_id
nullable string
The currently published version, or null if the template has never been published. Always null today — SMS templates are not yet versioned; present for parity with email templates.
revision
nullable integer
erforderlich
The draft's revision counter. Always null today — SMS templates are not yet versioned; present for parity with email templates.
created_at
nullable string
erforderlich
When the template was created. Null for built-in templates.
updated_at
nullable string
erforderlich
When the template was last updated. Null for built-in templates.