STstuut
business-units

Set Business Unit Mailboxes

Update which shared mailboxes are scoped to this business unit, and return the resulting mailboxes. The list is the complete set for THIS business unit only — a mailbox also scoped to other business units keeps those other assignments; only its membership in this one is added or removed.

  • Pass one or more mailbox IDs to scope those shared mailboxes to this business unit.
  • Pass an empty list ([]) to remove this business unit from every mailbox it was scoped to.

Only shared mailboxes can be scoped — a personal mailbox is always visible to its owner regardless of business unit, so assigning one here would have no effect. A hybrid mailbox's paired SendGrid sender (which isn't itself a selectable shared mailbox) is kept scoped identically, since it's what actually sends mail for a hybrid sender. Requires organization admin.

put/v2/business-units/{business_unit_id}/mailboxes

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

business_unit_idstring required

Request body

mailbox_idsstring[]

IDs of the shared mailboxes that should be scoped to this business unit.

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 1 revision of this API.