Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthNewsletter

Newsletter routes: create, get, list

The Newsletter Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Newsletter, one group of Newsletter routes.

Newsletter.create

Creates a Newsletter. Verb page.

Text
POST /{namespace}/newsletters

Body, as JSON: the inputs. Emits Newsletter.created.

Inputs

InputTypeRequiredDescription
namestringrequiredWhat subscribers see it called.
fromMailboxrequiredThe broadcast Mailbox each issue sends from.
topicstringThe topic a Contact subscribes to, recorded with their Consent.
offerOfferThe Offer whose Subscription unlocks paid issues and the archive.

Returns

OutputTypeRequiredDescription
newsletterNewsletterrequiredThe Newsletter.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/newsletters \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline notes","from":"mailbox_93HvOnR17L"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "newsletter": {
    "$id": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc",
    "$type": "Newsletter",
    "name": "Leaseline notes",
    "from": "mailbox_93HvOnR17L"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Newsletter.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Newsletter.get

Returns one Newsletter by id. Verb page.

Text
GET /{namespace}/newsletters/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Newsletter.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
newsletterNewsletterrequiredThe Newsletter.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Newsletter",
  "$id": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc",
  "newsletter": {
    "$id": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc",
    "$type": "Newsletter",
    "name": "Leaseline notes",
    "from": "mailbox_93HvOnR17L"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc",
    "up": "https://api.sb/leaseline.app/newsletters"
  },
  "actions": {
    "import": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc/import",
    "send": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc/send"
  }
}

Newsletter.list

Returns Newsletters, newest first, one page at a time. Verb page.

Text
GET /{namespace}/newsletters

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
newsletterslist of NewsletterrequiredOne page of Newsletters.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/newsletters?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Newsletter",
  "newsletters": [
    {
      "$id": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc",
      "$type": "Newsletter",
      "name": "Leaseline notes",
      "from": "mailbox_93HvOnR17L"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "newsletter_FLjN3aQujc"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/newsletters?limit=20",
    "next": "https://api.sb/leaseline.app/newsletters?after=newsletter_FLjN3aQujc"
  }
}

Newsletter

Previous

update, delete

Next