STstuut
mailboxes

Update a Mailbox

Updates editable fields: display name, signature, reply-to, and the shared / centralized-inbox flags. Connection state (provider, grant, permission type) is set by the auth flow, not here.

Permissions: the owner can update their own delegated mailbox; shared mailboxes can be updated by any org member; centralized inboxes require mailbox configuration rights.

patch/v2/mailboxes/{mailbox_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

mailbox_idstring required

Request body

namestring nullable

Email owner's name.

signature_htmlstring nullable

Email signature html.

is_centralized_inboxboolean nullable

Whether this sender is a centralized inbox that accepts net-new inbound emails for routing

is_sharedboolean nullable

Whether this email sender should be shared with the entire organization

reply_tostring nullable

This account's default reply-to

send_asstring email nullable

Alias to send outgoing mail from. Must be one of the mailbox's provider-verified email_aliases. Pass null to revert to the primary address.

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
emailstring required

The account's email.

email_aliasesstring[] nullable required
send_asstring email nullable required

Alias designated as the From address for outgoing mail. One of email_aliases, or null to send from the primary address.

namestring nullable required

Email owner's name.

providerstring nullable required

Mail provider — 'microsoft', 'google', 'imap', 'sendgrid', etc.

permission_type'delegated' | 'application' required

How a mailbox was authenticated.

is_sharedboolean required

Whether this email sender should be shared with the entire organization

is_centralized_inboxboolean required

Whether this sender is a centralized inbox that accepts net-new inbound emails for routing

status'connected' | 'expired' | 'disconnected' required

Computed connection health.

archived_atstring date-time nullable required

When the mailbox was disconnected from Stuut. Kept around for historical email attribution rather than deleted.

user_idstring nullable required

Owning user. NULL for shared mailboxes.

signature_htmlstring nullable required

Email signature html.

reply_tostring required

This account's default reply-to

business_unit_idsstring[] required

Business units this shared mailbox is scoped to. Empty means visible to all users in the organisation.

objectstring required

String representing the object's type. Objects of the same type share the same value.

uses_legacy_entra_appboolean required

True when this Microsoft mailbox's grant was minted against the legacy Entra app and must be re-authenticated to migrate onto the current app.

Changes

No recorded changes to this operation across all 2 revisions of this API.