Update an email template

PATCH

/v1/email/templates/{template_ref}

bird email templates update <template-ref> \
  --default-language pt-BR \
  --on-missing-language fallback \
  --revision 3

curl -X PATCH "https://us1.platform.bird.com/v1/email/templates/{template_ref}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "revision": 3,
    "default_language": "pt-BR",
    "on_missing_language": "fallback"
  }'

响应200

{
  "id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "slug": "welcome-email",
  "name": "Welcome email",
  "scope": "workspace",
  "status": "active",
  "category": "transactional",
  "source": "html",
  "theme": null,
  "draft_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
  "live_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
  "published_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
  "languages": {
    "en": {
      "status": "live"
    },
    "pt-BR": {
      "status": "live",
      "draft": true
    },
    "de": {
      "status": "draft"
    }
  },
  "default_language": "pt-BR",
  "available_languages": [
    "en"
  ],
  "on_missing_language": "fallback"
}

Updates a template's metadata and draft settings, such as its name or default language. Only the fields you send are changed.

Content is not edited here: save a language on the draft version instead.

Send the draft revision you last read. If someone else changed the draft first, including by saving a language, the revision is stale and the request returns a conflict so you can reload and retry.

参数

template_ref

string

The template's id (emt_…) or slug. On read, a built-in system template's bird_ slug also resolves here. Write operations (update, delete) accept a workspace template only, because a system template is immutable.

请求载荷

revision

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.

name

string

New display name, in free text. The slug stays fixed at creation, so renaming the template does not break whatever refers to it by slug or id.

description

nullable string

What the template is for, in your own words. Send null to clear it.

default_language

string

New default language for the draft. Must be one of the languages the draft already has, so add the language first if it is not there yet.

on_missing_language

string

What a send does when it asks for a language this template does not carry.

language_source_required

boolean

Whether a send has to name a language. Turning it on rejects a send that names none instead of serving the default language, and makes the template unusable for a broadcast, which has no way to name one.

响应载荷

string

必填

Template ID.

workspace_id

nullable string

必填

The workspace that owns the template. Null for a built-in system template, which no workspace owns.

slug

string

必填

The name you send the template by. You can use either the slug or the id when you send. It never changes after the template is created. A built-in system template's slug always starts with bird_.

name

string

必填

The template's display name, shown wherever the template is listed. You can change it any time. It defaults to the slug if you do not set one.

description

nullable string

必填

What the template is for, in your own words. Null if you have not set one.

scope

string

必填

Whether the template is one of our built-in templates (system) or one your workspace created (workspace).

Possible values: system, workspace

status

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 language is in review.
active: at least one language is live, so something can be sent.
rejected: it was reviewed and every language was refused.
inactive: nothing is live and nothing is in review, so content was withdrawn or was blocked before anything went live.

A template with one language live is active even while another is still drafted or refused. Read languages for the state of each language and its reason.

Which values a channel reports follows its review model. A channel whose content a third party reviews uses all five. On email and SMS, where content goes live on publish, a template is draft, active or inactive, and pending and rejected are reserved for the review stage coming to both, so a template reaching either is not a breaking change.

Possible values: draft, pending, active, rejected, inactive

Update an email template

相关资源