Skip to content

Put Work Notification Rules

PUT
/work/preferences/notification-rules

Create or replace the listed rules and return the caller’s full set. PERSONAL KEY ONLY.

One invalid rule refuses the whole request (422) before anything is written.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Rules to create or replace. One invalid rule refuses the whole request.

object
rules
required
Array<object>
>= 1 items <= 20 items

One notification rule being set. The owner and organization are the key’s person’s.

object
createdVia
string
default: settings <= 16 characters
id
Any of:
string
<= 64 characters
kind
required
string
>= 1 characters <= 32 characters
params
object
key
additional properties
any
surfaces
Array<string>
<= 8 items

Responses

200

Successful Response

object
data
required

A Work direct message, chat, approval decision, work item, question, rule set or suggestion list, as the app returns it.

object
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