Organization API: Org Staff Digest

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

GET /api/v1/orgs/{org_slug}/staff/digest

Which digest the signed-in member gets: off, daily or weekly.

can_receive is false for a role below billing, since a digest holds money figures, and reason then says who can. send_time and timezone say when it arrives: 07:00 in the brand's timezone, on Monday for a weekly one.

PUT /api/v1/orgs/{org_slug}/staff/digest

Choose the signed-in member's digest: off, daily or weekly.

Billing, admins and the owner can choose daily or weekly; any other role is refused with a 403 that says who can. Anyone can choose off. A digest chosen after 07:00 starts with the next send, and choosing the word already set changes nothing.

application/json (required)

GET /api/v1/orgs/{org_slug}/staff/digest/preview

The digest email the member would get, as a web page, built from the last period that ended: yesterday for daily, or the last whole week (Monday to Sunday) for weekly.

Needs billing or above, because a digest holds money figures. The page is sandboxed and never cached.