---
canonical_url: "https://docs.composio.dev/toolkits/microsoft_word"
markdown_url: "https://docs.composio.dev/toolkits/microsoft_word.md"
product: "platform"
version: null
last_updated: null
---

# Microsoft Word

Microsoft Word tools for finding, downloading, updating, and managing DOCX files in OneDrive and SharePoint through Microsoft Graph

- **Category:** documents
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 23
- **Triggers:** 0
- **Slug:** `MICROSOFT_WORD`
- **Version:** 00000000_00

## Tools

### Add Comment

**Slug:** `MICROSOFT_WORD_ADD_COMMENT`

Add a Word comment to one exact paragraph selected by text or a READ_DOCX locator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `author` | string | Yes | Comment author. |
| `comment` | string | Yes | Comment text. |
| `item_id` | string | Yes | DOCX item ID. |
| `drive_id` | string | Yes | Drive ID. |
| `initials` | string | No | Optional author initials. |
| `anchor_text` | string | No | Exact text of one document paragraph to comment. |
| `expected_etag` | string | No | Optional exact eTag concurrency guard; required when paragraph_locator selects an eTag-bound target. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Upload mode. |
| `paragraph_locator` | string | No | READ_DOCX paragraph locator; use instead of anchor_text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Append Content

**Slug:** `MICROSOFT_WORD_APPEND_CONTENT`

Append plain text or supported Markdown paragraphs, headings, formatted runs, lists, rectangular tables, safe http/https/mailto links, and Courier New inline or fenced code to a DOCX body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("markdown" | "plain") | No | Content format; Markdown supports safe links and Courier New code text. |
| `content` | string | Yes | Plain text or supported Markdown to append. Markdown preserves safe http, https, and mailto links; inline and fenced code use Courier New. |
| `item_id` | string | Yes | DOCX item ID. |
| `drive_id` | string | Yes | Drive ID. |
| `expected_etag` | string | No | Optional exact eTag concurrency guard. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Upload mode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy DOCX

**Slug:** `MICROSOFT_WORD_COPY_DOCX`

Copy a verified DOCX to a OneDrive or SharePoint folder, wait boundedly for the asynchronous operation, and return verified destination metadata. If waiting times out, the server-side copy may continue; inspect the destination before retrying to avoid creating another copy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `new_name` | string | No | New filename ending in .docx; omit to keep the source filename. Cannot be combined with include_all_version_history because Graph can ignore version-history copying when a new name is supplied. |
| `source_item_id` | string | Yes | Source DOCX driveItem ID. |
| `source_drive_id` | string | Yes | Drive containing the source DOCX. |
| `destination_drive_id` | string | Yes | Drive where the copied DOCX will be created. |
| `wait_timeout_seconds` | number | No | Maximum time to wait for Microsoft to report completion. A timeout is ambiguous because the server-side copy can continue. |
| `destination_folder_id` | string | Yes | Destination folder driveItem ID. |
| `include_all_version_history` | boolean | No | Copy all source versions instead of only the latest version. Requires new_name to be omitted because Graph can ignore version-history copying when a new name is supplied. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create DOCX

**Slug:** `MICROSOFT_WORD_CREATE_DOCX`

Create a safe DOCX containing styled paragraphs and formatted runs, bullet or decimal lists, rectangular tables, or constrained HTML/Markdown source with safe external links and inline or fenced code rendered in Courier New, plus validated inline PNG/JPEG images, page breaks, and default/first/even headers and footers. Literal content is escaped and raw XML or image URLs are never accepted. The create-only default fails on a filename conflict. overwrite_existing remains available for backward compatibility; prefer UPSERT_DOCX when replacement is intended.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blocks` | array | No | Ordered paragraph, table, inline-image, and page-break blocks. Legacy objects containing only text and style remain valid paragraphs. |
| `source` | string | No | Constrained HTML or Markdown source. Provide exactly one of source or blocks; parsed content is converted to the same validated block model. |
| `footers` | object | No | Optional default, first, and even footer paragraphs. |
| `headers` | object | No | Optional default, first, and even header paragraphs. |
| `drive_id` | string | Yes | Destination OneDrive or SharePoint document-library drive ID. |
| `filename` | string | Yes | Destination filename ending in .docx. Path separators are rejected. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Upload mode. Keep the recommended auto setting to use direct upload through 10 MiB and resilient resumable upload above it. Force direct only when resumability is unwanted, or resumable when interruption recovery is required for a smaller document. |
| `parent_folder_id` | string | Yes | Destination folder driveItem ID. |
| `overwrite_existing` | boolean | No | Deprecated compatibility field. When true, replace a same-name item; prefer UPSERT_DOCX for that intent. The safe false default creates only and fails on a name conflict. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create DOCX sharing link

**Slug:** `MICROSOFT_WORD_CREATE_DOCX_SHARING_LINK`

Create a view, edit, or embed sharing link for a verified DOCX. Returns Graph's capability-bearing URL; treat it as a secret. Sharing can change the document eTag, so call READ_DOCX again before editing. Setting retain_inherited_permissions=false removes all existing permissions when the item is shared for the first time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | DOCX driveItem ID. |
| `drive_id` | string | Yes | Drive containing the DOCX to share. |
| `link_type` | string ("view" | "edit" | "embed") | No | Link behavior: read-only view, read-write edit, or embeddable embed. Defaults to view. |
| `link_scope` | string ("anonymous" | "organization" | "users") | No | Optional audience: anonymous, organization, or specified users. When omitted, Graph uses the organization's default link scope. |
| `sharing_passcode` | string | No | Optional password sent to Graph for this link. Availability depends on tenant sharing policy and plan; personal OneDrive may require a Microsoft 365 Personal or Family paid plan. |
| `expiration_datetime` | string | No | Optional link expiration timestamp in ISO 8601 format. On personal OneDrive, this capability may require a Microsoft 365 Personal or Family paid plan. |
| `retain_inherited_permissions` | boolean | No | Whether to retain inherited permissions when sharing the item for the first time. Setting false removes all existing permissions, which is destructive; omit to use Graph's default behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete DOCX

**Slug:** `MICROSOFT_WORD_DELETE_DOCX`

Move one DOCX to the provider recycle bin only when its current eTag matches. This action does not bypass shared locks or checked-out state. A successful result does not guarantee permanent erasure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | DOCX driveItem ID to move to the provider recycle bin. |
| `drive_id` | string | Yes | Drive containing the DOCX. |
| `expected_etag` | string | Yes | Current driveItem eTag; deletion fails if the item changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit DOCX

**Slug:** `MICROSOFT_WORD_EDIT_DOCX`

Atomically edit literal text, paragraphs, independent Latin/non-complex and complex-script run formatting, lists, rectangular tables including plain cells and rows outside merged regions, uploaded inline PNG/JPEG images, semantic comments, tracked text changes, revision acceptance or rejection, safe external hyperlinks, paired footnotes, section headers or footers, and explicit page breaks in a DOCX. Targets are semantic locators from READ_DOCX and remain valid only for its eTag. The complete package is validated before one guarded replacement upload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | DOCX driveItem ID. |
| `drive_id` | string | Yes | OneDrive or SharePoint document-library drive ID. |
| `operations` | array | Yes | Ordered, eTag-bound semantic edits. Every operation must change content and succeed atomically. Text is limited to 1,000,000 characters; at most 20 uploaded images, 10 MiB each and 25 MiB total, may be inserted. |
| `expected_etag` | string | Yes | Exact eTag returned by READ_DOCX; the edit fails if the document changed. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Upload mode. Keep the recommended auto setting to use direct upload through 10 MiB and resilient resumable upload above it. Force direct only when resumability is unwanted, or resumable when interruption recovery is required for a smaller document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export DOCX to PDF

**Slug:** `MICROSOFT_WORD_EXPORT_DOCX`

Convert a DOCX of at most 2 MB to PDF through Microsoft Graph and return a temporary file reference. The provider's preauthenticated redirect URL is followed internally and is never returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | DOCX driveItem ID. |
| `drive_id` | string | Yes | Drive containing the DOCX to export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fill Template

**Slug:** `MICROSOFT_WORD_FILL_TEMPLATE`

Fill run-spanning placeholders in main-document paragraphs of a validated DOCX template snapshot, then create and return a new document. Strict mode creates only after every requested placeholder is found; non-strict mode can create a partial fill and reports found, filled, and unfilled keys. If post-upload validation fails, the error identifies the retained destination item and gives guarded cleanup guidance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | object | Yes | Placeholder keys mapped to literal values. Keys contain 1 to 255 characters and cannot contain braces. The original main document may contain at most 100 unique placeholders under the same key grammar. |
| `file_name` | string | Yes | New .docx filename. |
| `expected_etag` | string | No | Optional exact template eTag guard before destination creation. |
| `fail_on_missing` | boolean | No | When true, fail before destination creation if any requested main-document placeholder is absent. When false, create a partial fill and report absent requested keys by comparing the requested values keys with placeholders_filled. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Filled-copy upload mode. |
| `template_item_id` | string | Yes | Template DOCX item ID. |
| `placeholder_style` | string ("{{key}}" | "{key}") | No | Placeholder delimiter style. |
| `template_drive_id` | string | Yes | Drive containing the template and destination folder. |
| `wait_timeout_seconds` | number | No | Deprecated compatibility field; filling no longer performs an async copy. |
| `destination_folder_id` | string | Yes | Destination folder in template_drive_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find DOCX files

**Slug:** `MICROSOFT_WORD_FIND_DOCX_FILES`

Browse one folder or search a drive for DOCX files. Browse pages also return folders for navigation. Search results can be eventually consistent; use a direct read action when authoritative current state is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("browse" | "search") | Yes | Browse one folder's immediate children or search the entire drive. |
| `query` | string | No | Filename, metadata, or content search text; required in search mode. |
| `cursor` | string | No | Opaque cursor returned by the prior page; omit for the first page. |
| `drive_id` | string | Yes | OneDrive or SharePoint document-library drive ID. |
| `page_size` | integer | No | Maximum upstream items to inspect on this page (1-200). Filtering can yield fewer returned items. |
| `folder_item_id` | string | No | Folder driveItem ID; required in browse mode. Use the actual root item ID, not the word root. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find SharePoint sites

**Slug:** `MICROSOFT_WORD_FIND_SHAREPOINT_SITES`

Find accessible SharePoint sites by keyword, or resolve one known hostname and site path to its site ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Free-text site keyword query; required only when lookup_mode is search. This searches matching sites and does not enumerate every accessible site. |
| `cursor` | string | No | Opaque cursor returned by a prior search page; omit for the first page and for path lookup. |
| `hostname` | string | No | SharePoint hostname such as tenant.sharepoint.com; required only for path lookup. |
| `page_size` | integer | No | Maximum sites to return on this search page (1-100); ignored for path lookup. |
| `site_path` | string | No | Server-relative site path without the hostname, such as sites/Legal; required only for path lookup. |
| `lookup_mode` | string ("search" | "path") | Yes | Use search for a keyword query or path when the SharePoint hostname and site-relative path are known. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Microsoft Word account context

**Slug:** `MICROSOFT_WORD_GET_ACCOUNT_CONTEXT`

Return the signed-in Microsoft identity and primary OneDrive identifiers needed to start OneDrive DOCX work. Microsoft Graph documents that GET /me/drive automatically provisions OneDrive when the delegated user is licensed but does not yet have a drive.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invite DOCX recipients

**Slug:** `MICROSOFT_WORD_INVITE_DOCX_RECIPIENTS`

Grant read or write access to required named recipients. send_invitation and require_sign_in are required; emailing an invitation is an irreversible external side effect. Partial success is reported per recipient. Sharing can change the document eTag, so call READ_DOCX again before editing. Setting retain_inherited_permissions=false removes all existing permissions when the item is shared for the first time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | Yes | Required read and/or write roles to grant. |
| `item_id` | string | Yes | DOCX driveItem ID. |
| `message` | string | No | Optional plain-text invite message, up to 2,000 characters. |
| `drive_id` | string | Yes | Drive containing the DOCX to share. |
| `recipients` | array | Yes | Required recipients, each identified by exactly one email, alias, or directory objectId. |
| `require_sign_in` | boolean | Yes | Required: whether recipients must sign in to access the DOCX. |
| `send_invitation` | boolean | Yes | Required: whether Graph should email the sharing invitation. |
| `sharing_passcode` | string | No | Optional password sent to Graph for this sharing permission. Availability depends on tenant sharing policy and plan; personal OneDrive may require a Microsoft 365 Personal or Family paid plan. |
| `expiration_datetime` | string | No | Optional sharing permission expiration timestamp in ISO 8601 format. On personal OneDrive, this capability may require a Microsoft 365 Personal or Family paid plan. |
| `retain_inherited_permissions` | boolean | No | Whether to retain inherited permissions when sharing the item for the first time. Setting false removes all existing permissions, which is destructive; omit to use Graph's default behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List DOCX versions

**Slug:** `MICROSOFT_WORD_LIST_DOCX_VERSIONS`

Validate the selected drive item as a DOCX, then return one page of retained versions in Microsoft Graph's newest-first order. Provider download URLs and raw identity objects are omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque cursor returned by the prior page. Omit it for the first page and pass it back unchanged to continue. |
| `item_id` | string | Yes | DOCX driveItem ID. |
| `drive_id` | string | Yes | Drive containing the DOCX. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List OneDrive drives

**Slug:** `MICROSOFT_WORD_LIST_ONEDRIVES`

Return one page of drives available to the signed-in user as the Microsoft Word toolkit's OneDrive-drive selector for DOCX workflows. Unlike GET_ACCOUNT_CONTEXT, this lists drives without returning identity context or selecting only the primary drive. Use LIST_SHAREPOINT_LIBRARIES for a specific SharePoint site's document libraries; general OneDrive file automation may use ONE_DRIVE_LIST_DRIVES instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque cursor returned by the prior page. Omit it for the first page and pass it back unchanged to continue. |
| `page_size` | integer | No | Maximum OneDrive drives to return on this page (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SharePoint document libraries

**Slug:** `MICROSOFT_WORD_LIST_SHAREPOINT_LIBRARIES`

Return one page of document libraries and available root folder item IDs for a SharePoint site ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque cursor returned by the prior page. Omit it for the first page and pass it back unchanged to continue. |
| `site_id` | string | Yes | SharePoint site ID returned by FIND_SHAREPOINT_SITES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move or rename DOCX

**Slug:** `MICROSOFT_WORD_MOVE_OR_RENAME_DOCX`

Rename a DOCX, move it within the same drive, or do both, guarded by its current eTag. At least one of new_name or destination_folder_id is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | DOCX driveItem ID. |
| `drive_id` | string | Yes | Drive containing the DOCX. |
| `new_name` | string | No | New filename ending in .docx. At least one of new_name or destination_folder_id is required. |
| `expected_etag` | string | Yes | Current driveItem eTag; the update fails if the item changed. |
| `destination_folder_id` | string | No | Destination folder driveItem ID in the same drive. At least one of new_name or destination_folder_id is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read DOCX

**Slug:** `MICROSOFT_WORD_READ_DOCX`

Safely inspect a DOCX as bounded rich OOXML: paragraphs and editable text segments, directly formatted runs, tables and merged-cell metadata, internal images, hyperlinks with withheld targets, paired footnotes, semantic comment threads, pending revisions, page breaks, sections with header/footer references, and the style catalog. Existing image framing is inspected without pixel decoding and image records share a 100-megapixel aggregate safety bound. Returns the current eTag required by every locator and never exposes download URLs, external relationship targets, or document bytes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parts` | array | No | OOXML text-bearing parts to read. Document includes body paragraphs, table cells, and text boxes in the main document part. |
| `item_id` | string | Yes | DOCX driveItem ID. |
| `drive_id` | string | Yes | OneDrive or SharePoint document-library drive ID. |
| `max_characters` | integer | No | Maximum text characters to return across all selected parts (1000-500000). |
| `max_paragraphs` | integer | No | Maximum paragraphs to return across all selected parts (1-2000). |
| `max_structural_elements` | integer | No | Maximum paragraphs, runs, tables, rows, cells, images, page breaks, sections, and section references returned across selected parts in package order (1-20000). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Text

**Slug:** `MICROSOFT_WORD_REPLACE_TEXT`

Replace literal text across Word run boundaries in a DOCX, optionally as tracked revisions. Uses an optional eTag guard and retries one definite stale unpinned write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `find` | string | Yes | Literal text to find. |
| `author` | string | No | Revision author when tracking changes. |
| `item_id` | string | Yes | DOCX item ID. |
| `replace` | string | Yes | Literal replacement text. |
| `drive_id` | string | Yes | Drive ID. |
| `match_case` | boolean | No | Use case-sensitive matching. |
| `occurrence` | string ("first" | "all") | No | Replace the first or all matches. |
| `expected_etag` | string | No | Optional exact eTag concurrency guard. |
| `track_changes` | boolean | No | Record replacements as revisions. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Upload mode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve Tracked Changes

**Slug:** `MICROSOFT_WORD_RESOLVE_TRACKED_CHANGES`

Accept or reject all pending tracked revisions, or selected revision locators returned by READ_DOCX.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("accept_all" | "reject_all" | "accept" | "reject") | Yes | Accept or reject all revisions, or selected READ_DOCX revision locators. |
| `item_id` | string | Yes | DOCX item ID. |
| `drive_id` | string | Yes | Drive ID. |
| `expected_etag` | string | No | Optional exact eTag concurrency guard; required for accept or reject with eTag-bound revision locators. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Upload mode. |
| `revision_locators` | array | No | Required unique revision locators for accept or reject. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore DOCX version

**Slug:** `MICROSOFT_WORD_RESTORE_DOCX_VERSION`

Restore a retained DOCX version as a new current version, preserving version history, then observe the item's current metadata in a post-operation read. That metadata does not independently prove which version supplied the current content. A required eTag check rejects already-stale callers before mutation, but Graph does not document an atomic If-Match precondition for this operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | DOCX driveItem ID. |
| `drive_id` | string | Yes | Drive containing the DOCX. |
| `version_id` | string | Yes | Version ID returned by LIST_DOCX_VERSIONS. |
| `expected_etag` | string | Yes | Exact current eTag returned by READ_DOCX. The restore is rejected before the request if the document has already changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Share DOCX

**Slug:** `MICROSOFT_WORD_SHARE_DOCX`

Backward-compatible wrapper for sharing a verified DOCX. Prefer CREATE_DOCX_SHARING_LINK for links and INVITE_DOCX_RECIPIENTS for named recipients. mode defaults to create_link. Invite mode requires recipients, roles, send_invitation, and require_sign_in. create_link returns Graph's intended sharing capability URL so it can be delivered to the intended audience; treat that URL as a secret. Other capability tokens, raw identity data, and raw provider error details are omitted; a bounded provider reason may be returned for a failed request. Partial invite success is reported per recipient. Sharing can change the document eTag and invalidate READ_DOCX locators; call READ_DOCX again before editing. Password protection depends on tenant sharing policy and plan; personal OneDrive may require Microsoft 365 Personal or Family. Setting retain_inherited_permissions=false removes all existing permissions when the item is shared for the first time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("create_link" | "invite") | No | Use create_link for a view, edit, or embed link or invite for named recipients. Defaults to create_link. |
| `roles` | array | No | Required for invite mode: read and/or write roles to grant. |
| `item_id` | string | Yes | DOCX driveItem ID. |
| `message` | string | No | Optional plain-text invite message, up to 2,000 characters. |
| `drive_id` | string | Yes | Drive containing the DOCX to share. |
| `link_type` | string ("view" | "edit" | "embed") | No | For create_link, create a read-only view, read-write edit, or embeddable embed link. Defaults to view. Omit this field in invite mode. |
| `link_scope` | string ("anonymous" | "organization" | "users") | No | Optional create_link audience: anonymous, organization, or specified users. Use invite mode to grant named recipients directly. When omitted, Graph uses the organization's default link scope. |
| `recipients` | array | No | Required for invite mode: recipients identified by exactly one email, alias, or directory objectId. |
| `require_sign_in` | boolean | No | Required for invite mode: whether recipients must sign in. |
| `send_invitation` | boolean | No | Required for invite mode: whether Graph should email the invitation. |
| `sharing_passcode` | string | No | Optional password sent to Graph for this sharing permission. Availability depends on tenant sharing policy and plan; personal OneDrive may require a Microsoft 365 Personal or Family paid plan. |
| `expiration_datetime` | string | No | Optional sharing permission expiration timestamp in ISO 8601 format. On personal OneDrive, this capability may require a Microsoft 365 Personal or Family paid plan. |
| `retain_inherited_permissions` | boolean | No | Whether to retain inherited permissions when sharing the item for the first time. Setting false removes all existing permissions, which is destructive; omit to use Graph's default behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert DOCX

**Slug:** `MICROSOFT_WORD_UPSERT_DOCX`

Create or replace a same-name DOCX containing the same validated content supported by CREATE_DOCX. Replacement is always enabled; use CREATE_DOCX for create-only conflict behavior.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blocks` | array | No | Ordered paragraph, table, inline-image, and page-break blocks. Legacy objects containing only text and style remain valid paragraphs. |
| `source` | string | No | Constrained HTML or Markdown source. Provide exactly one of source or blocks; parsed content is converted to the same validated block model. |
| `footers` | object | No | Optional default, first, and even footer paragraphs. |
| `headers` | object | No | Optional default, first, and even header paragraphs. |
| `drive_id` | string | Yes | Destination OneDrive or SharePoint document-library drive ID. |
| `filename` | string | Yes | Destination filename ending in .docx. Path separators are rejected. |
| `upload_strategy` | string ("auto" | "direct" | "resumable") | No | Upload mode. Keep the recommended auto setting to use direct upload through 10 MiB and resilient resumable upload above it. Force direct only when resumability is unwanted, or resumable when interruption recovery is required for a smaller document. |
| `parent_folder_id` | string | Yes | Destination folder driveItem ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |