Skip to content

Set Work Sidebar Preferences

POST
/work/sidebar-preferences

Store how this principal wants its own sidebar ordered.

Both halves are required and closed to alpha | recent. There is no read route here because there is none in the app: the stored value rides the room payload (GET /work/room).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

How this person wants their own sidebar ordered.

Both halves are required and closed-vocabulary, exactly as normalizeSidebarSortMode requires them (index.ts:10838): a partial write would leave the other half at whatever a previous client wrote and make the response a lie about the stored state.

object
channels
required
string
Allowed values: alpha recent
directMessages
required
string
Allowed values: alpha recent

Responses

200

Successful Response

object
data
required

This principal’s stored sidebar ordering.

object
preferences
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