Marketing | Hanzo Docs

Package marketing is lifecycle email: drip sequences that reach the right people.

35 commands · API reference →

Command	Calls	What it does
`hanzo marketing audiences preview <id>`	`GET /v1/marketing/audiences/{id}/preview`	Evaluates the cohort LIVE — the same resolution an enrollment would run — and reports how big it is and how many real…
`hanzo marketing audiences get <id>`	`GET /v1/marketing/audiences/{id}`	Returns one of the caller org's saved audiences.
`hanzo marketing audiences rm <id>`	`DELETE /v1/marketing/audiences/{id}`	Removes one of the caller org's audiences and answers 204.
`hanzo marketing audiences list`	`GET /v1/marketing/audiences`	Returns the org's saved audiences, most recently updated first.
`hanzo marketing audiences create`	`POST /v1/marketing/audiences`	Saves a cohort filter for the caller's org.
`hanzo marketing calendar publish <id>`	`POST /v1/marketing/calendar/{id}/publish`	Publishes a post NOW, synchronously, whatever its schedule.
`hanzo marketing calendar get <id>`	`GET /v1/marketing/calendar/{id}`	Returns one of the caller org's posts, including the exact error behind a failed publish.
`hanzo marketing calendar set <id>`	`PUT /v1/marketing/calendar/{id}`	Replaces a post's editable fields.
`hanzo marketing calendar rm <id>`	`DELETE /v1/marketing/calendar/{id}`	Removes one of the caller org's posts and answers 204.
`hanzo marketing calendar list`	`GET /v1/marketing/calendar`	Returns the org's calendar, latest scheduled first, optionally narrowed to one status.
`hanzo marketing calendar create`	`POST /v1/marketing/calendar`	Adds a post to the content calendar.
`hanzo marketing campaigns schedule <id>`	`POST /v1/marketing/campaigns/{id}/schedule`	Sets a campaign's send time and moves it to "scheduled".
`hanzo marketing campaigns get <id>`	`GET /v1/marketing/campaigns/{id}`	Returns one of the caller org's campaigns.
`hanzo marketing campaigns set <id>`	`PUT /v1/marketing/campaigns/{id}`	Replaces a campaign's editable fields.
`hanzo marketing campaigns rm <id>`	`DELETE /v1/marketing/campaigns/{id}`	Removes one of the caller org's campaigns and answers 204.
`hanzo marketing campaigns list`	`GET /v1/marketing/campaigns`	Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status.
`hanzo marketing campaigns create`	`POST /v1/marketing/campaigns`	Registers a campaign in the caller's org.
`hanzo marketing promos eligibility <code>`	`GET /v1/marketing/promos/{code}/eligibility`	Prices a promo against a plan and seat count.
`hanzo marketing promos redeem <code>`	`POST /v1/marketing/promos/{code}/redeem`	Records the caller org's claim on a promo.
`hanzo marketing promos redemption <code>`	`GET /v1/marketing/promos/{code}/redemption`	Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's.
`hanzo marketing promos list`	`GET /v1/marketing/promos`	Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many…
`hanzo marketing sequences enroll <id>`	`POST /v1/marketing/sequences/{id}/enroll`	Adds one contact or a whole audience to a sequence and schedules the first step for each.
`hanzo marketing sequences enrollments cancel <id> <eid>`	`POST /v1/marketing/sequences/{id}/enrollments/{eid}/cancel`	Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
`hanzo marketing sequences enrollments list <id>`	`GET /v1/marketing/sequences/{id}/enrollments`	Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due time.
`hanzo marketing sequences status <id>`	`POST /v1/marketing/sequences/{id}/status`	Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
`hanzo marketing sequences steps get <id>`	`GET /v1/marketing/sequences/{id}/steps`	Returns one sequence's steps in send order.
`hanzo marketing sequences steps create <id>`	`POST /v1/marketing/sequences/{id}/steps`	Appends a message to the END of a sequence: the new step's idx is one past the last, so steps arrive in the order they…
`hanzo marketing sequences get <id>`	`GET /v1/marketing/sequences/{id}`	Returns one of the caller org's sequences together with its steps in send order.
`hanzo marketing sequences list`	`GET /v1/marketing/sequences`	Returns the org's drip sequences, most recently updated first.
`hanzo marketing sequences create`	`POST /v1/marketing/sequences`	Registers a drip sequence in the caller's org.
`hanzo marketing summary`	`GET /v1/marketing/summary`	Rolls up the caller org's campaigns: how many there are, how many are active, and the summed budget and spend in cents.
`hanzo marketing suppressions get`	`GET /v1/marketing/suppressions`	Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to.
`hanzo marketing suppressions create`	`POST /v1/marketing/suppressions`	Records an opt-out for the org (admin / self-service management).
`hanzo marketing suppressions clear`	`DELETE /v1/marketing/suppressions`	Re-subscribes an address on one channel and answers 204.
`hanzo marketing unsubscribe`	`GET /v1/marketing/unsubscribe`	Is the PUBLIC one-click endpoint (no principal): a recipient clicks the signed link in an email footer.