Objects
Newsletter
A newsletter of the account: its settings, the radars its template uses, its next send.
{
"id": 12,
"name": "Weekly Market Radar",
"live": true,
"schedule": { "cadence": "weekly", "weekday": 1, "time": "09:00", "time_zone": "Europe/Paris" },
"subject_pattern": "issue",
"review": true,
"reviewer": { "email": "aiko@acme.com", "name": "Aiko Tanaka" },
"hold_back": false,
"recipients": 12,
"radar_ids": [37, 41],
"next_send_at": "2026-10-05T07:00:00Z",
"template_version": "2026-09-29T14:02:11.482913+00:00"
}live: whether it assembles and sends issues. Turned on and off in the app only.schedule:weekdayis ISO, 1 is Monday; a monthly newsletter sends on the first of that weekday.timeis local totime_zone, on the hour or the half hour.subject_pattern:issue(Weekly Market Radar, issue 15),date(…, 5 October) orissue_date(both).reviewer: a member of the workspace, ornull. Withreviewon, each issue goes to them an hour before it is sent; withhold_backon, an issue not approved in time is not sent.recipients: how many are subscribed.radar_ids: the radars its template uses.next_send_at:nullwhen it is not live.template_version: changes whenever the template does, and only then.
To create one or change its settings, see Newsletters in the endpoints guide.