Documentation
Sign inGet started

bird email templates versions languages update

Usage

Code example
bird email templates versions languages update <template-ref> <version-id> <language> [flags]

Description

Update one language of a draft
Change some fields of one language on a template's draft, leaving the rest as they are.
Build the request from flags, a JSON EmailTemplateLanguageUpdate 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 versions languages update --example

# the body it prints:
Code example
{
  "html": "<h1>Hi {{ bird.contact.first_name }}</h1>",
  "preview_text": "{{ bird.contact.first_name }}, your order is on its way",
  "subject": "Welcome to Acme, {{ bird.contact.first_name }}!"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--subjectA new email subject line for this language.
--preview-textA new line for the inbox to show after the subject in the message list. Send null to clear it, and the inbox shows the opening words of the body instead.
--htmlA new HTML body for this language.
--textA new plain-text body for this language. Send null to clear it, and a plain-text alternative is derived from the HTML when you submit.
--revision <n>The revision you last read for this language, to detect a concurrent edit. The edit is rejected with a conflict if the language moved on since. Omit it to apply the edit unconditionally.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email templates versions languages deleteDelete one language from a draft
bird email templates versions languages getGet one language of a version
bird email templates versions languages listList a version's languages
bird email templates versions languages setUpsert one language of a draft