Skip to content

Set Inbox Mailbox Visibility

PATCH
/inbox/mailboxes/{mailbox}/visibility

Share a mailbox with the team, or make it personal again.

THIS CHANGES WHO CAN READ THE THREADS IN IT. Sharing exposes the conversation history of that mailbox to every team member; un-sharing hides it again, but not retroactively.

ONLY THE OWNER may change it - the person the mailbox was created by. An API key acts as its minting human, so a key held by anyone else gets a 403, and an org-scoped key (which owns nothing) always does.

Authorizations

Parameters

Path Parameters

mailbox
required

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

string

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

Query Parameters

shared_with_team
required

True makes the mailbox and its threads visible to the whole team. False makes it personal to its owner.

boolean

True makes the mailbox and its threads visible to the whole team. False makes it personal to its owner.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

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