Skip to content
Tinbox
Sign in

CLI command

tinbox create-campaign

Create a COMPLETE email campaign (newsletter) draft in one call: audience (and optional segment), subject, body, sender identity (from/reply-to), a PROPOSED send time, and a short rationale for your choices. The draft lands in the campaign builder for human review — it never sends or schedules itself. Use list_audiences / list_segments first to resolve ids by name, and get_send_readiness('broadcast') before creating.

Generated from tool: create_campaign

Usage

sh
tinbox create-campaign --audienceId <audienceId> --segmentId <segmentId> --title <title> --subject <subject> --content <content> --fromName <fromName> --fromEmail <fromEmail> --replyTo <replyTo> --previewText <previewText> --proposedSendAt <proposedSendAt> --rationale <rationale>

Flags

NameTypeRequiredDefaultDescription
--audienceIdstringyes—The audience to send to (resolve by name via list_audiences).
--segmentIdstringyes—Optional saved/static segment within the audience (resolve by name via list_segments).
--titlestringyes—Internal title for the campaign.
--subjectstringyes—Email subject line.
--contentstringyes—Email body content (markdown or HTML).
--fromNamestringyes—Sender name (defaults to audience setting).
--fromEmailstringyes—Sender email (defaults to audience setting).
--replyTostringyes—Reply-to address (defaults to audience setting).
--previewTextstringyes—Inbox preview text (the line under the subject).
--proposedSendAtstringyes—PROPOSED send time (Unix ms). Stored on the draft only — a human must approve and schedule before anything sends.
--rationalestringyes—One short paragraph on the choices made (which audience/segment and why, the proposed schedule and why). Shown to the reviewer in the builder's proposed-by banner.