Sign inGet Started

bird whatsapp templates update

Usage

Przykład kodu
bird whatsapp templates update <template-ref> [flags]

Description

Update a message template
Changes a template's display name, description, and language policies. The slug can change before the first submission; the old slug then stops resolving, while the template ID stays the same. Content is edited separately on a language of the draft.
Build the request from flags, a JSON WhatsAppTemplateUpdate 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

Przykład kodu
# print the body shape (no credentials needed)
bird whatsapp templates update --example

# the body it prints:
Przykład kodu
{
  "default_language": "en",
  "name": "Order update",
  "on_missing_language": "fallback",
  "slug": "welcome-email"
}

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
--slugA new workspace-unique handle. Editable only before the first submission. After a change, the old slug no longer resolves; the template ID stays the same.
--nameThe template's display name. Editable at any time; it is not what a send references.
--descriptionWhat the template is for. Send null to clear it.
--default-languageThe language a send falls back to, and the one language the template is required to carry. Repointing it at a language the draft does not hold is refused, the same way removing the current default is: add the language first.
--on-missing-languageHow a send behaves when it asks for a language this template does not carry. Omitting it leaves the template's current setting alone. The fail default belongs to a create, and a partial update never reapplies it. Possible values: fallback, fail.
--language-source-requiredWhether a send has to name a language.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp templates createCreate a WhatsApp template, optionally seeding its first draft
bird whatsapp templates deleteDelete a message template
bird whatsapp templates duplicateDuplicate a message template
bird whatsapp templates getGet a message template
bird whatsapp templates listList available message templates