broadcast
engine-dmo broadcast: The crm module's broadcasts: list, show, draft, test-send, schedule, send, cancel, report. Every subcommand, argument and flag.
engine-dmo
The crm module’s broadcasts: list, show, draft, test-send, schedule, send, cancel, report.
| Command | What it does |
|---|---|
engine-dmo broadcast cancel | Cancel a draft, a scheduled broadcast or the rest of a sending one; messages already queued still go |
engine-dmo broadcast draft | Write a draft from a YAML or JSON file (subject, preheader, format, body, list); a new one, or with --id the draft it names |
engine-dmo broadcast list | List a site’s broadcasts, newest first |
engine-dmo broadcast report | A broadcast’s figures: recipients by delivery state, who was left out, unsubscribes, clicks per link and opens |
engine-dmo broadcast schedule | Schedule a draft to go at a time (RFC 3339, or 2006-01-02T15:04 in the site’s zone); needs --confirm |
engine-dmo broadcast send | Send a draft now; needs --confirm, since a send cannot be taken back |
engine-dmo broadcast show | Show a broadcast, its body and who its list reaches now, with who it leaves out and why |
engine-dmo broadcast test-send | Send a test of the broadcast to one address, with [Test] before its subject and placeholder merge fields |
engine-dmo broadcast cancel
Cancel a draft, a scheduled broadcast or the rest of a sending one; messages already queued still go.
engine-dmo broadcast cancel [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--id | string | broadcast id |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo broadcast draft
Write a draft from a YAML or JSON file (subject, preheader, format, body, list); a new one, or with --id the draft it names.
engine-dmo broadcast draft [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--file | string | the draft as YAML or JSON | |
--id | string | rewrite this draft rather than start one | |
--site | string | site key, for a new draft |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo broadcast list
List a site’s broadcasts, newest first.
engine-dmo broadcast list [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--site | string | site key | |
--status | string | draft | scheduled | sending | sent | cancelled |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo broadcast report
A broadcast’s figures: recipients by delivery state, who was left out, unsubscribes, clicks per link and opens.
engine-dmo broadcast report [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--id | string | broadcast id |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo broadcast schedule
Schedule a draft to go at a time (RFC 3339, or 2006-01-02T15:04 in the site’s zone); needs --confirm.
engine-dmo broadcast schedule [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--at | string | when it goes | |
--confirm | bool | schedule it | |
--id | string | broadcast id |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo broadcast send
Send a draft now; needs --confirm, since a send cannot be taken back.
engine-dmo broadcast send [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--confirm | bool | send it | |
--id | string | broadcast id |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo broadcast show
Show a broadcast, its body and who its list reaches now, with who it leaves out and why.
engine-dmo broadcast show [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--id | string | broadcast id |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo broadcast test-send
Send a test of the broadcast to one address, with [Test] before its subject and placeholder merge fields.
engine-dmo broadcast test-send [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--id | string | broadcast id | |
--to | string | the address the test goes to |
--json prints the text output in the JSON envelope. Runs in a project.