Skip to content

by startups.studio

by Startups.Studio

Growth Newsletter

Newsletter.send

POST /{namespace}/newsletters/{newsletter}/send

Send emails one issue, a piece of Content, to every subscribed Contact, and a paid issue only to those whose Offer covers it.

Noun: Newsletter
Mode: do
Event: Newsletter.sent

You, to your agent

Send the latest newsletter with content.

curl -X POST https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc/send \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content":"content_HYlnoorBdP"}'

import { $ } from 'startup-builder'

const newsletter = await $.Newsletter.send({ newsletter: 'newsletter_FLjN3aQujc', content: 'content_HYlnoorBdP' })

npx startup-builder do Newsletter.send --json '{"newsletter":"newsletter_FLjN3aQujc","content":"content_HYlnoorBdP"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Newsletter.send({ newsletter: 'newsletter_FLjN3aQujc', content: 'content_HYlnoorBdP' })"
  }
}

Inputs

Input	Type	Required	Description
`newsletter`	Newsletter	required	The Newsletter.
`content`	Content	required	The issue to send.
`at`	`datetime`		When to send it. Unset: now.

Outputs

Output	Type	Required	Description
`newsletter`	Newsletter	required	The Newsletter, with the issue in its archive.

Effects

Fact	Value
Action class	`send`, a Message to many people at once: a broadcast or a Sequence. It waits for you where a seat's approval rule names it
Door	One-way: it waits out its delay window, then runs
Modes	`try` previews it and stores nothing; `send` returns a pending Action; `do` (default) waits for the result
Idempotent	With a key: a repeat with the same `Idempotency-Key` returns the first Action, and a repeat without one runs again
Undo	Action.undo reverses its records
Emits	`Newsletter.sent`
Performed by	The Marketing Lead

Skips Suppressions and withdrawn Consent; every email carries a one-click unsubscribe link.
Publishes the issue to the archive on the Site, gated by the Newsletter’s Offer.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Newsletter.list

Previous

Newsletter.update

Next