Skip to main content
PATCH
Update inbox
Required scope: INBOXES_WRITE

Behavior

Updates only the fields you send and returns the inbox. Sending sources replaces the whole list. Sending filters replaces the saved filters, and "filters": null clears them. The app’s Needs action and Mine settings on the inbox are kept either way. Sending "emoji": "" clears the emoji. An absent or null emoji keeps it. To mute an inbox, send {"notifications_muted": true}. To unmute it, send false. Send user_id in the JSON body to update a teammate’s inbox. Only admins and managers of the teammate’s workspace can do that. An inbox with no source in a workspace the caller manages returns 404. Sending sources replaces only the lines in the caller’s workspaces: the teammate’s lines from other workspaces are kept.

Errors

Authorizations

Authorization
string
header
required

Path Parameters

inbox_id
string
required

Inbox ID (inb-*).

Example:

"inb-abc123"

Body

application/json
name
string

Cannot be blank.

Maximum string length: 80
Example:

"Sales"

emoji
string | null

"" clears the emoji. Absent or null keeps it.

Maximum string length: 16
Example:

"💼"

sources
object[]

Replaces the whole list. With user_id, only the lines in the caller's workspaces are replaced.

Maximum array length: 100
filters
object | null

Replaces the saved filters. null clears them, absent keeps them. The app's Needs action and Mine settings are kept either way.

notifications_muted
boolean
Example:

false

user_id
string

Update this teammate's inbox (usr-*). The caller must be an admin or manager of that teammate's workspace.

Example:

"usr-abc123"

Response

Inbox updated

data
object