Microsoft: Update the navigation property mail Folders in users
Microsoft usersMailFolder.updateMailFolders: arguments, response, policy and SDK examples.
← Users mail folder operations · Get started
Operation microsoft.users_updatemailfolders
Provider route: PATCH /users/{user-id}/mailFolders/{mailFolder-id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MicrosoftIntegration } from "@alter-ai/microsoft";
async function execute(input: Parameters<MicrosoftIntegration["usersMailFolder"]["updateMailFolders"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.usersMailFolder.updateMailFolders(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_microsoft import MicrosoftIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.users_mail_folder.update_mail_folders(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.user-id | string | Required within parent | |
path.mailFolder-id | string | Required within parent | |
body | Model | Required within parent | Expand Create Mail Folder — request body — body |
Referenced models: Create Mail Folder — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get mail Folder — response body |
Referenced models: Get mail Folder — response body
Schemas
Section titled “Schemas”23 more schemas are linked from the tables above, on the schema pages.
Get mail Folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).childFolderCount | JSON | Optional | |
$ (allOf 2).childFolderCount (anyOf 1) | JSON | Alternative | |
$ (allOf 2).childFolderCount (anyOf 1) (anyOf 1) | number | Alternative | The number of immediate child mailFolders in the current mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).childFolderCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).childFolderCount (anyOf 2) | null | Alternative | |
$ (allOf 2).childFolders | array | Optional | The collection of child folders in the mailFolder. |
$ (allOf 2).childFolders[] | Model | Each item | Expand Get mail Folder — response body |
$ (allOf 2).displayName | JSON | Optional | |
$ (allOf 2).displayName (anyOf 1) | string | Alternative | The mailFolder's display name. |
$ (allOf 2).displayName (anyOf 2) | null | Alternative | |
$ (allOf 2).isHidden | JSON | Optional | |
$ (allOf 2).isHidden (anyOf 1) | boolean | Alternative | Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders. |
$ (allOf 2).isHidden (anyOf 2) | null | Alternative | |
$ (allOf 2).messageRules | array | Optional | The collection of rules that apply to the user's Inbox folder. |
$ (allOf 2).messageRules[] | Model | Each item | Expand Get rule — response body |
$ (allOf 2).messages | array | Optional | The collection of messages in the mailFolder. |
$ (allOf 2).messages[] | Model | Each item | Expand Get message — response body |
$ (allOf 2).multiValueExtendedProperties | array | Optional | The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable. |
$ (allOf 2).multiValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item |
$ (allOf 2).parentFolderId | JSON | Optional | |
$ (allOf 2).parentFolderId (anyOf 1) | string | Alternative | The unique identifier for the mailFolder's parent mailFolder. |
$ (allOf 2).parentFolderId (anyOf 2) | null | Alternative | |
$ (allOf 2).singleValueExtendedProperties | array | Optional | The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable. |
$ (allOf 2).singleValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item |
$ (allOf 2).totalItemCount | JSON | Optional | |
$ (allOf 2).totalItemCount (anyOf 1) | JSON | Alternative | |
$ (allOf 2).totalItemCount (anyOf 1) (anyOf 1) | number | Alternative | The number of items in the mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).totalItemCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).totalItemCount (anyOf 2) | null | Alternative | |
$ (allOf 2).unreadItemCount | JSON | Optional | |
$ (allOf 2).unreadItemCount (anyOf 1) | JSON | Alternative | |
$ (allOf 2).unreadItemCount (anyOf 1) (anyOf 1) | number | Alternative | The number of items in the mailFolder marked as unread. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).unreadItemCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).unreadItemCount (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id, Get mail Folder — response body, Get message — response body, Get rule — response body, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item
Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).value | array | Optional | A collection of property values. |
$ (allOf 2).value[] | JSON | Each item | |
$ (allOf 2).value[] (anyOf 1) | string | Alternative | |
$ (allOf 2).value[] (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).value | JSON | Optional | |
$ (allOf 2).value (anyOf 1) | string | Alternative | A property value. |
$ (allOf 2).value (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Create Mail Folder — request body — body @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count child Folders item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).childFolderCount | JSON | Optional | |
$ (allOf 2).childFolderCount (anyOf 1) | number | Alternative | The number of immediate child mailFolders in the current mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).childFolderCount (anyOf 2) | null | Alternative | |
$ (allOf 2).displayName | JSON | Optional | |
$ (allOf 2).displayName (anyOf 1) | string | Alternative | The mailFolder's display name. |
$ (allOf 2).displayName (anyOf 2) | null | Alternative | |
$ (allOf 2).isHidden | JSON | Optional | |
$ (allOf 2).isHidden (anyOf 1) | boolean | Alternative | Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders. |
$ (allOf 2).isHidden (anyOf 2) | null | Alternative | |
$ (allOf 2).parentFolderId | JSON | Optional | |
$ (allOf 2).parentFolderId (anyOf 1) | string | Alternative | The unique identifier for the mailFolder's parent mailFolder. |
$ (allOf 2).parentFolderId (anyOf 2) | null | Alternative | |
$ (allOf 2).totalItemCount | JSON | Optional | |
$ (allOf 2).totalItemCount (anyOf 1) | number | Alternative | The number of items in the mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).totalItemCount (anyOf 2) | null | Alternative | |
$ (allOf 2).unreadItemCount | JSON | Optional | |
$ (allOf 2).unreadItemCount (anyOf 1) | number | Alternative | The number of items in the mailFolder marked as unread. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).unreadItemCount (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: microsoft.users_updatemailfolders. Catalog operation: users_updatemailfolders. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["Mail.ReadWrite"]