inbox
Get Inbox Open Count
How many open conversations the reader may read -- the number the rail's Everything entry carries, without the rail. Use for a badge. Changes nothing.
Get Inbox Open Count › Responses
Successful Response
countSet Inbox Preferences
Change the reader's rail: how it opens, views hidden, order, each entry's layout.
Set Inbox Preferences › Request Body
Set Inbox Preferences › Responses
Successful Response
collapsedhidden_entriesGet Inbox Rail
The reader's rail, in order, each entry with how many open conversations
match it -- to_review first, only while the reader may read a thread with
a reply an agent prepared for review. time_zone (IANA) bounds a view's
period in the reader's days.
query Parameters
time_zoneGet Inbox Rail › Responses
Successful Response
can_sharemax_viewsA person's inbox preferences (rules 15 and 39), kept with their
membership. collapsed is whether the rail opens collapsed;
hidden_entries the keys of the predefined views they hid.
shownCreate Inbox View
Save the filters in force as a view in the reader's rail.
Create Inbox View › Request Body
The inbox's filters (inbox.md rule 17), by the names its address gives
them. A name the inbox does not recognise is refused, never dropped
(extra="forbid"); every one is optional, and an unset one is absent.
The values are the address's: holder, channelKey, agentId,
endReason, counterparty, answeredBy, label and preparedReply hold
several values joined by commas; since/until are calendar days in the reader's own zone; the
either-way filters are yes or no; unreplied is on or absent. An
answer sends an unset filter as null, which the address reads as absent;
what is stored leaves it out.
namesharedshow_countCreate Inbox View › Responses
Successful Response
editableThe inbox's filters (inbox.md rule 17), by the names its address gives
them. A name the inbox does not recognise is refused, never dropped
(extra="forbid"); every one is optional, and an unset one is absent.
The values are the address's: holder, channelKey, agentId,
endReason, counterparty, answeredBy, label and preparedReply hold
several values joined by commas; since/until are calendar days in the reader's own zone; the
either-way filters are yes or no; unreplied is on or absent. An
answer sends an unset filter as null, which the address reads as absent;
what is stored leaves it out.
idminenamesharedshow_countUpdate Inbox View
Rename a view, save filters over it, share or unshare it, or switch its count.
path Parameters
view_idUpdate Inbox View › Request Body
Update Inbox View › Responses
Successful Response
editableThe inbox's filters (inbox.md rule 17), by the names its address gives
them. A name the inbox does not recognise is refused, never dropped
(extra="forbid"); every one is optional, and an unset one is absent.
The values are the address's: holder, channelKey, agentId,
endReason, counterparty, answeredBy, label and preparedReply hold
several values joined by commas; since/until are calendar days in the reader's own zone; the
either-way filters are yes or no; unreplied is on or absent. An
answer sends an unset filter as null, which the address reads as absent;
what is stored leaves it out.
idminenamesharedshow_count