Skip to content

Set Work Inbox Disposition

POST
/work/inbox-dispositions

Snooze, archive or reactivate one conversation, for this principal only.

state: "snoozed" REQUIRES a future snoozedUntil; the app refuses a snooze without a wake-up with a 422.

Authorizations

Parameters

Header Parameters

Idempotency-Key
Any of:
string

Retry-safety key. Replaying one returns the ORIGINAL result with duplicate: true instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.

X-Target-Org-Id
Any of:
string

Request Body required

One conversation moving between the Inbox’s three states.

latest_activity_at is the conversation boundary the decision was made at, not a timestamp of the decision: a newer inbound message must re-activate a snoozed or archived conversation without erasing the record that somebody once set it aside. That is why the state is stored per conversation rather than as a flag on the conversation itself.

object
channel
required
string
>= 1 characters <= 255 characters
conversationKey
required
string
>= 1 characters <= 512 characters
latestActivityAt
required
integer
rootId
required
string
>= 1 characters <= 128 characters
snoozedUntil
Any of:
string
<= 64 characters
state
required
string
Allowed values: active snoozed archived

Responses

200

Successful Response

object
data
required

One conversation’s Inbox state after a write.

object
disposition
Any of:
object
key
additional properties
any
duplicate
Any of:
boolean
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