Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Inbox

Update inbox category

<small>Requires the inbox:write scope (or a broader one that includes it).</small>

Full replacement of name and color for a category. Reserved (system) categories reject this operation with 403 / code: inboxCategory.cannotModifyDefault.

put/v3/inbox/threads/categories/{id}

Path parameters

idinteger required

Request body

namestring required
color'gray' | 'green' | 'blue' | 'red' | 'yellow' | 'purple' | 'orange' | 'lightBlue' | 'olive' required

Response

Category updated

idinteger required
namestring required
color'gray' | 'green' | 'blue' | 'red' | 'yellow' | 'purple' | 'orange' | 'lightBlue' | 'olive' required
isReservedboolean required

True for system-reserved categories (e.g., the default category). Reserved categories cannot be renamed, recoloured, or deleted.

unreadThreadsCountinteger required

Number of unread threads currently assigned to this category.