Newsletter

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc",
  "$type": "Newsletter",
  "name": "Leaseline notes",
  "from": "mailbox_93HvOnR17L",
  "topic": "product-updates",
  "subscribers": 1,
  "offer": "offer_2hzYe1ERo0"
}

RelationshipsCopy Anchor Link

• A Newsletter sends from one Mailbox: every issue sends from one broadcast Mailbox. sendsFrom, inverse newsletters.

VerbsCopy Anchor Link

1. createCreates a Newsletter.
   POST /{namespace}/newslettersdoNewsletter.created
2. getReturns one Newsletter by id.
   GET /{namespace}/newsletters/{id}readNo Event
3. listReturns Newsletters, newest first, one page at a time.
   GET /{namespace}/newslettersreadNo Event
4. updateChanges the given properties of a Newsletter.
   PATCH /{namespace}/newsletters/{id}doNewsletter.updated
5. deleteDeletes a Newsletter: a soft delete that keeps its history, undone by `Thing.restore`.
   DELETE /{namespace}/newsletters/{id}doNewsletter.deleted
6. importImport adds subscribers from a CSV File, keeping each one’s consent basis and the date they subscribed.
   POST /{namespace}/newsletters/{newsletter}/importdoNewsletter.imported
7. sendSend emails one issue, a piece of Content, to every subscribed Contact, and a paid issue only to those whose Offer covers it.
   POST /{namespace}/newsletters/{newsletter}/senddoNewsletter.sent

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

In code: API · SDK · CLI · MCP.

Send the latest newsletter with content.

Works withCopy Anchor Link

ExampleCopy Anchor Link

Leaseline’s Newsletter on lease law sends from its broadcast Mailbox to 900 subscribers. The monthly issue goes to all of them; the weekly issue goes only to subscribers whose Subscription to the $8 Offer covers it.