Duplicate an email template

POST

/v1/email/templates/{template_ref}/duplicate

bird email templates duplicate <template-ref> --slug welcome-email-copy

curl -X POST "https://us1.platform.bird.com/v1/email/templates/{template_ref}/duplicate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "welcome-email-copy"
  }'

响应201

{
  "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"
}

Creates a new template by copying an existing one: one of your workspace templates, or a built-in system template (by its bird_ slug). The copy is a new template with its own id and a single editable draft seeded from the source's current content. It inherits the source's category, authoring format (source), and description. Copying a workspace template also carries over its default language and its missing-language policy, so the copy behaves like what it was copied from. The copy starts unpublished.

By default the copy's slug derives from the source's slug, for example welcome-email-copy, with a numeric suffix added if that slug is already taken. Supply slug to choose your own. A slug already in use in the workspace returns a conflict.

参数

template_ref

string

The source template to copy: a workspace template's id (emt_…) or slug, or a built-in system template's bird_ slug. The copy is always a new workspace template.

请求载荷

slug

string

The copy's workspace-unique handle, and the stable alternative to the template ID when sending by template. It can contain lowercase letters, numbers, hyphens, and underscores. Omit it to derive one from the source (for example, welcome-email-copy), with a numeric suffix if that slug is already taken. Two prefixes are rejected: bird_, reserved for our built-in templates, and emt_, the template ID format, which a slug could never be distinguished from. If you supply a slug that is already in use in the workspace, the request returns a conflict.

响应载荷

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

Duplicate an email template

相关资源