STstuut
mailboxes

Set Mailbox Business Units

Assigns a shared mailbox to one or more business units. This is a full replacement — the provided list becomes the complete set of assignments.

  • Pass one or more BU IDs to scope the mailbox to those BUs.
  • Pass an empty list ([]) to remove all scoping, making the mailbox visible to all users in the organisation (the default behaviour).

Users scoped to a business unit will only see collections-inbox triage threads from mailboxes assigned to their business unit (or unscoped mailboxes). For a hybrid mailbox (Nylas + a paired SendGrid sender), the paired sender is scoped identically since it's what actually sends mail. Requires organisation admin.

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

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

business_unit_idsstring[]

IDs of business units to scope this mailbox to.

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.