bird email templates update

Usage

Code example

bird email templates update <template-ref> [flags]

Description

Update an email template

Change a template's metadata and draft settings without editing its content. Save content on the draft version. Pass the last-read draft revision; a concurrent edit returns a conflict.

Build the request from flags, a JSON EmailTemplateUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example

# print the body shape (no credentials needed)
bird email templates update --example

# the body it prints:

Code example

{
  "default_language": "pt-BR",
  "on_missing_language": "fallback",
  "revision": 3
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--revision <n>	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	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	What the template is for, in your own words. Send null to clear it.
--default-language	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	What a send does when it asks for a language this template does not carry. Possible values: fallback, fail.
--language-source-required	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.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email templates create	Create an email template and its first editable draft
bird email templates delete	Delete an email template
bird email templates duplicate	Duplicate an email template
bird email templates get	Get an email template
bird email templates list	List email templates
bird email templates preview	Preview a template with sample values