Skip to content

Set Work Daily Brief

POST
/work/preferences/daily-brief

Store THIS principal’s daily-brief schedule.

An unknown timezone is a 422 rather than a UTC guess: a brief is a scheduled send, and a wrong zone delivers a morning brief at midnight.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

When this person wants their daily brief.

The timezone is the one field that is REFUSED rather than defaulted. A brief is a scheduled send, and an unrecognised zone has no defensible fallback: guessing UTC delivers somebody’s morning brief at midnight, silently, forever. weekdays and localTime do have a defensible default (weekdays at 08:00) and take it, which is the gateway’s split too.

object
enabled
boolean
localTime
Any of:
string
<= 5 characters
timezone
required
string
>= 1 characters <= 100 characters
weekdays
Any of:
Array<integer>
<= 7 items

Responses

200

Successful Response

object
data
required

This principal’s daily-brief schedule and, on a read, its delivery status.

object
settings
Any of:
object
key
additional properties
any
status
Any of:
object
key
additional properties
any
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string