Newsletter routes: import, send

Reference for Newsletter, one group of Newsletter routes.

Newsletter.import

Import adds subscribers from a CSV File, keeping each one’s consent basis and the date they subscribed. Verb page.

Text

POST /{namespace}/newsletters/{newsletter}/import

Path: newsletter. Body, as JSON: the other inputs. Emits Newsletter.imported.

Inputs

Input	Type	Required	Description
`newsletter`	Newsletter	required	The Newsletter.
`file`	File	required	The CSV, one subscriber per row.
`basis`	`string`	required	How they consented, as the old tool recorded it.

Returns

Output	Type	Required	Description
`newsletter`	Newsletter	required	The Newsletter, with its new subscribers counted.

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.
A row with no email, and skips a suppressed address	`refused`	Clear what the check names, then call it again.	None.

Example

Terminal

curl -X POST https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc/import \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"file":"file_V1AuhyCTsH","basis":"Example basis"}'

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.import",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

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. Verb page.