sms-templates

Get an SMS template version

Returns one version with its variables and text in every language. A workspace draft is editable, while published workspace versions are immutable. A built-in template exposes its current catalogue content through a synthetic published version.

get/v1/sms/templates/{template_ref}/versions/{version_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/sms/templates/{template_ref}/versions/{version_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The requested SMS template version.

idstring required
template_idstring required
version_numberinteger nullable required

Sequential publication number. Null for the draft; a built-in template reports 1.

status'draft' | 'published' required

Whether the version is the editable draft or published. Published workspace versions are immutable and remain published after a later version goes live. A built-in template's synthetic published version projects the current catalogue entry.

revisioninteger required

The version revision. A draft revision advances with each metadata or content change. Published workspace versions are frozen; a built-in template's synthetic version reports 0.

languagesobject required

Full content for each language, keyed by canonical BCP-47 tag.

default_languagestring required

A language tag in BCP-47 form, for example en or pt-BR.

created_atstring date-time nullable required

When the version was created. Null for a built-in template's synthetic version.

published_atstring date-time nullable required

When the version was published. Null for the draft and for a built-in template's synthetic version.

Example response

{
  "id": "smv_01krdgeqcxet5s7t44vh8rt9mg",
  "template_id": "smt_01krdgeqcxet5s7t44vh8rt9mg",
  "version_number": 1,
  "status": "published",
  "revision": 1,
  "variables": [
    {
      "key": "order_number",
      "type": "text",
      "required": true,
      "constraint": "A string, number, or boolean."
    }
  ],
  "languages": {
    "en": {
      "text": "Your order {{ order_number }} is on its way.",
      "revision": 1,
      "content_hash": "sha256:3d948846f5f773fb7bed8ab81b57f3d0ff2cbff24cb549718f4d389f1ab0300a",
      "updated_at": "2026-09-10T09:00:00Z"
    }
  },
  "default_language": "en",
  "created_at": "2026-09-10T09:00:00Z",
  "published_at": "2026-09-10T09:00:00Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.