bird email unsubscribe-page update

Usage

Contoh kode

bird email unsubscribe-page update [flags]

Description

Restyle the hosted page a marketing recipient lands on when they unsubscribe

Every field is nullable, and a null returns that one to the built-in style: the page shows the company name again, or its automatic dark theme. No flag sends a null, so a reset needs an explicit null in the request body, and --body-file takes a path or "-" for stdin, never inline JSON. Setting any color fixes the palette and turns the dark theme off, so set all three or none. Changes reach new page views within a few minutes, and links already sent pick them up.

Build the request from flags, a JSON EmailUnsubscribePageUpdate 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

Contoh kode

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

# the body it prints:

Contoh kode

{
  "accent_color": "#2563eb",
  "background_color": "#fafaf9",
  "name": "Acme",
  "text_color": "#100f0c"
}

Contoh kode

# name the sender the page shows
bird email unsubscribe-page update --name Acme

# fix the whole palette
bird email unsubscribe-page update --background-color '#fafaf9' --text-color '#100f0c' --accent-color '#2563eb'

# clear the sender name (a null only reaches the wire on stdin)
echo '{"name": null}' | bird email unsubscribe-page update --body-file -

# return every color to the built-in style
echo '{"background_color": null, "text_color": null, "accent_color": null}' | bird email unsubscribe-page update --body-file -

Options

Appearance

Name	Description
--name	Sender name the page shows (e.g. "Acme")
--background-color	Page background, hex (e.g. "#fafaf9")
--text-color	Page text, hex (e.g. "#100f0c")
--accent-color	Confirm button, hex (e.g. "#2563eb")

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
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email unsubscribe-page get	Get the unsubscribe-page settings