Get newsletter
get_newsletterThe blog's email newsletter: whether it is on, how many readers subscribed, and what happened to recent posts. Use it when the human asks about subscribers, email readers or why a post wasn't emailed. Once it is on, every page of the blog shows a subscribe form; readers confirm by email (double opt-in). Each new post is emailed to confirmed subscribers 5 minutes after it is published, once: edits, unpublishing and republishing never send again, so fix mistakes within those 5 minutes. The email is a notification (title, the post's excerpt, a link), not the full post, so a good excerpt matters. Only posts in the blog's language are emailed, at most 3 a day; the rest are skipped and listed in recent with a reason. Pro only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| blog_id | No | Your blog's id, as returned by signup. Optional with an API key: it defaults to the key's blog, and any id you pass must be that blog. Required when the server runs without API keys. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| live | No | The subscribe form shows and new posts are emailed: enabled, Pro, not suspended. | |
| plan | No | "free" or "pro". | |
| error | No | ||
| recent | No | The last 10 posts the newsletter handled, newest first. | |
| blog_id | No | ||
| enabled | No | The owner turned the newsletter on. | |
| sending | No | SlopIt is sending newsletter email at all right now. When false, nothing is emailed yet; subscribe requests are kept. | |
| suspended | No | SlopIt stopped this blog’s newsletter; turning it on again is refused. | |
| subscribers | No |