Sign in

v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
mailboxes

Rename a mailbox (its display contact name). Mailbox admins only.

partial=True keeps true PATCH semantics: omitting name is a no-op rather than a 400, so the runtime matches the optional request schema.

patch/api/v1.0/mailboxes/{id}/

Path parameters

idstring required

Request body

namestring

Response

idstring uuid required

primary key for the record as UUID

emailstring required
namestring nullable required

Return the display name of the mailbox (its contact name).

domain_idstring uuid required
is_identityboolean required

Whether this mailbox identifies a person (i.e. is not an alias or a group)

is_sharedboolean required

Return True if the mailbox is shared (non-identity or has more than one access).

Drives mailbox-level UI gating for collaboration features (assignment sub-folders, mention folder) that have no purpose in a mono-user identity mailbox.

role'viewer' | 'editor' | 'sender' | 'admin' required
count_unread_threadsinteger required

Return the number of threads with unread messages in the mailbox.

count_threadsinteger required

Return the number of threads in the mailbox.

count_deliveringinteger required

Return the number of threads with messages being delivered.

count_unread_mentionsinteger required

Return the number of threads with unread mentions for the current user.

count_assignedinteger required

Return the number of threads in this mailbox currently assigned to the current user.