Skip to main content
Microsoft Word logo
  • Category: documents
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 23
  • Triggers: 0
  • Slug: MICROSOFT_WORD
  • Version: 20261101_00

Tools

Slug: MICROSOFT_WORD_ADD_COMMENTAdd a Word comment to a paragraph selected by a READ_DOCX locator or by exact text that uniquely matches a main-document paragraph. A locator requires the document’s eTag.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_APPEND_CONTENTAppend 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

string ("markdown" | "plain")
Content format; Markdown supports safe links and Courier New code text.
string
required
Plain text or supported Markdown to append. Markdown preserves safe http, https, and mailto links; inline and fenced code use Courier New.
string
required
DOCX item ID.
string
required
Drive ID.
string
Optional exact eTag concurrency guard.
string ("auto" | "direct" | "resumable")
Upload mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_COPY_DOCXCopy a Graph DOCX item with both a .docx filename and DOCX MIME type 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.

Input Parameters

string
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.
string
required
Source DOCX driveItem ID.
string
required
Drive containing the source DOCX.
string
required
Drive where the copied DOCX will be created.
number
Maximum time to wait for Microsoft to report completion. A timeout is ambiguous because the server-side copy can continue.
string
required
Destination folder driveItem ID.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_CREATE_DOCXCreate 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

array
Ordered paragraph, table, inline-image, and page-break blocks. Legacy objects containing only text and style remain valid paragraphs.
string
Constrained HTML or Markdown source. Provide exactly one of source or blocks; parsed content is converted to the same validated block model.
object
Optional default, first, and even footer paragraphs.
object
Optional default, first, and even header paragraphs.
string
required
Destination OneDrive or SharePoint document-library drive ID.
string
required
Destination filename ending in .docx. Path separators are rejected.
string ("auto" | "direct" | "resumable")
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.
string
required
Destination folder driveItem ID.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_DELETE_DOCXMove 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

string
required
DOCX driveItem ID to move to the provider recycle bin.
string
required
Drive containing the DOCX.
string
required
Current driveItem eTag; deletion fails if the item changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_EDIT_DOCXAtomically 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

string
required
DOCX driveItem ID.
string
required
OneDrive or SharePoint document-library drive ID.
array
required
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.
string
required
Exact eTag returned by READ_DOCX; the edit fails if the document changed.
string ("auto" | "direct" | "resumable")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_EXPORT_DOCXConvert 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

string
required
DOCX driveItem ID.
string
required
Drive containing the DOCX to export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_FILL_TEMPLATEFill run-spanning placeholders in main-document paragraphs of a validated DOCX template snapshot, then create a new document. Strict mode requires every requested placeholder to be found; non-strict mode can create a partial fill and reports found, filled, and unfilled keys.

Input Parameters

object
required
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.
string
required
New .docx filename.
string
Optional exact template eTag guard before destination creation.
boolean
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.
string ("auto" | "direct" | "resumable")
Filled-copy upload mode.
string
required
Template DOCX item ID.
string ("{{key}}" | "{key}")
Placeholder delimiter style.
string
required
Drive containing the template and destination folder.
number
Deprecated compatibility field; filling no longer performs an async copy.
string
required
Destination folder in template_drive_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_FIND_DOCX_FILESBrowse 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_FIND_SHAREPOINT_SITESFind accessible SharePoint sites by keyword, or resolve one known hostname and site path to its site ID.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_GET_ACCOUNT_CONTEXTReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_INVITE_DOCX_RECIPIENTSGrant 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

array
required
Required read and/or write roles to grant.
string
required
DOCX driveItem ID.
string
Optional plain-text invite message, up to 500 characters.
string
required
Drive containing the DOCX to share.
array
required
Required recipients, each identified by exactly one email, alias, or directory objectId.
boolean
required
Required: whether recipients must sign in to access the DOCX.
boolean
required
Required: whether Graph should email the sharing invitation.
string
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.
string
Optional sharing permission expiration timestamp in ISO 8601 format. On personal OneDrive, this capability may require a Microsoft 365 Personal or Family paid plan.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_LIST_DOCX_VERSIONSValidate 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

string
Opaque cursor returned by the prior page. Omit it for the first page and pass it back unchanged to continue.
string
required
DOCX driveItem ID.
string
required
Drive containing the DOCX.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_LIST_ONEDRIVESReturn 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

string
Opaque cursor returned by the prior page. Omit it for the first page and pass it back unchanged to continue.
integer
Maximum OneDrive drives to return on this page (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_LIST_SHAREPOINT_LIBRARIESReturn one page of document libraries and available root folder item IDs for a SharePoint site ID.

Input Parameters

string
Opaque cursor returned by the prior page. Omit it for the first page and pass it back unchanged to continue.
string
required
SharePoint site ID returned by FIND_SHAREPOINT_SITES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_MOVE_OR_RENAME_DOCXRename 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

string
required
DOCX driveItem ID.
string
required
Drive containing the DOCX.
string
New filename ending in .docx. At least one of new_name or destination_folder_id is required.
string
required
Current driveItem eTag; the update fails if the item changed.
string
Destination folder driveItem ID in the same drive. At least one of new_name or destination_folder_id is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_READ_DOCXInspect a DOCX as bounded rich OOXML, including paragraphs, formatted runs, tables, images, hyperlinks, footnotes, comments, revisions, page breaks, sections and styles. Returns an eTag for locators, withholds download URLs, external relationship targets and document bytes, and applies a 100-megapixel aggregate bound to PNG and JPEG image records.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_REPLACE_TEXTReplace the first or all occurrences of literal text in the main document of a DOCX, including matches across Word run boundaries. Matching can be case-sensitive or case-insensitive, and replacements can be recorded as tracked revisions. An optional eTag guards against editing a different document version.

Input Parameters

string
required
Literal text to find.
string
Revision author when tracking changes.
string
required
DOCX item ID.
string
required
Literal replacement text.
string
required
Drive ID.
boolean
Use case-sensitive matching.
string ("first" | "all")
Replace the first or all matches.
string
Optional exact eTag concurrency guard.
boolean
Record replacements as revisions.
string ("auto" | "direct" | "resumable")
Upload mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_RESOLVE_TRACKED_CHANGESAccept or reject supported pending run-level insertions and deletions in a DOCX, either all or selected revision locators returned by READ_DOCX. Accept-all and reject-all fail if the document contains unsupported revision forms; selected locators require the corresponding eTag.

Input Parameters

string ("accept_all" | "reject_all" | "accept" | "reject")
required
Accept or reject all revisions, or selected READ_DOCX revision locators.
string
required
DOCX item ID.
string
required
Drive ID.
string
Optional exact eTag concurrency guard; required for accept or reject with eTag-bound revision locators.
string ("auto" | "direct" | "resumable")
Upload mode.
array
Required unique revision locators for accept or reject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_RESTORE_DOCX_VERSIONRestore 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

string
required
DOCX driveItem ID.
string
required
Drive containing the DOCX.
string
required
Version ID returned by LIST_DOCX_VERSIONS.
string
required
Exact current eTag returned by READ_DOCX. The restore is rejected before the request if the document has already changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_SHARE_DOCXShare a verified DOCX by creating a link or inviting named recipients, returning sanitized permission outcomes and a partial-success flag; recipient identities may not be included. Sharing links are capability URLs to treat as secrets, and disabling inherited-permission retention can remove existing permissions on first share.

Input Parameters

string ("create_link" | "invite")
Use create_link for a view, edit, or embed link or invite for named recipients. Defaults to create_link.
array
Required for invite mode: read and/or write roles to grant.
string
required
DOCX driveItem ID.
string
Optional plain-text invite message, up to 500 characters.
string
required
Drive containing the DOCX to share.
For create_link, create a read-only view, read-write edit, or embeddable embed link. Defaults to view. Omit this field in invite mode.
Optional create_link audience: anonymous, organization, or specified users. Use invite mode to grant named recipients directly. When omitted, Graph uses the drive’s default link scope, which can be anonymous.
array
Required for invite mode: recipients identified by exactly one email, alias, or directory objectId.
boolean
Required for invite mode: whether recipients must sign in.
boolean
Required for invite mode: whether Graph should email the invitation.
string
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.
string
Optional sharing permission expiration timestamp in ISO 8601 format. On personal OneDrive, this capability may require a Microsoft 365 Personal or Family paid plan.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_WORD_UPSERT_DOCXCreate 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

array
Ordered paragraph, table, inline-image, and page-break blocks. Legacy objects containing only text and style remain valid paragraphs.
string
Constrained HTML or Markdown source. Provide exactly one of source or blocks; parsed content is converted to the same validated block model.
object
Optional default, first, and even footer paragraphs.
object
Optional default, first, and even header paragraphs.
string
required
Destination OneDrive or SharePoint document-library drive ID.
string
required
Destination filename ending in .docx. Path separators are rejected.
string ("auto" | "direct" | "resumable")
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.
string
required
Destination folder driveItem ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not