Office client application and platform availability for Office Add-ins

To work as expected, your Office Add-in might depend on a specific Office application, a requirement set, an API member, or a version of the API. The following tables contain the available platforms, extension points, API requirement sets, and Common APIs that are currently supported for each Office application.

Excel
Excel
OneNote
OneNote
Outlook
Outlook
PowerPoint
PowerPoint
Project
Project
Word
Word

Note

The initial Office 2016 release installed via MSI only contains the ExcelApi 1.1, WordApi 1.1, and Common API requirement sets. For more information about the update history of the various Office versions, check out the See also section. Office Add-ins may not be supported on all services that are members of the Office Cloud Storage Partner Program, which enables integrating Office on the web to work with Office documents as part of their service offering. For more information, please contact the member service.

Excel

Platform Extension points API requirement sets Common APIs
Office on the web - TaskPane
- Content
- CustomFunctions
- Add-in Commands
- ExcelApi 1.1
- ExcelApi 1.2
- ExcelApi 1.3
- ExcelApi 1.4
- ExcelApi 1.5
- ExcelApi 1.6
- ExcelApi 1.7
- ExcelApi 1.8
- ExcelApi 1.9
- ExcelApi 1.10
- ExcelApi 1.11
- ExcelApi 1.12
- ExcelApi 1.13
- ExcelApi 1.14
- ExcelApi 1.15
- ExcelApi 1.16
- ExcelApi 1.17
- ExcelApiOnline
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- RibbonApi 1.1
- SharedRuntime 1.1
- SharedRuntime 1.2
- KeyboardShortcuts 1.1
- BindingEvents
- CompressedFile
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
Office on Windows
- Microsoft 365 subscription
- retail perpetual Office 2016 and later
- TaskPane
- Content
- CustomFunctions
- Add-in Commands
- ExcelApi 1.1
- ExcelApi 1.2
- ExcelApi 1.3
- ExcelApi 1.4
- ExcelApi 1.5
- ExcelApi 1.6
- ExcelApi 1.7
- ExcelApi 1.8
- ExcelApi 1.9
- ExcelApi 1.10
- ExcelApi 1.11
- ExcelApi 1.12
- ExcelApi 1.13
- ExcelApi 1.14
- ExcelApi 1.15
- ExcelApi 1.16
- ExcelApi 1.17
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- RibbonApi 1.1
- SharedRuntime 1.1
- SharedRuntime 1.2
- KeyboardShortcuts 1.1
- BindingEvents
- CompressedFile
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
Office 2021 on Windows
(volume-licensed perpetual)
- TaskPane
- Content
- CustomFunctions
- Add-in Commands
- ExcelApi 1.1
- ExcelApi 1.2
- ExcelApi 1.3
- ExcelApi 1.4
- ExcelApi 1.5
- ExcelApi 1.6
- ExcelApi 1.7
- ExcelApi 1.8
- ExcelApi 1.9
- ExcelApi 1.10
- ExcelApi 1.11
- ExcelApi 1.12
- ExcelApi 1.13
- ExcelApi 1.14
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- RibbonApi 1.1
- SharedRuntime 1.1
- BindingEvents
- CompressedFile
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
Office 2019 on Windows
(volume-licensed perpetual)
- TaskPane
- Content
- Add-in Commands
- ExcelApi 1.1
- ExcelApi 1.2
- ExcelApi 1.3
- ExcelApi 1.4
- ExcelApi 1.5
- ExcelApi 1.6
- ExcelApi 1.7
- ExcelApi 1.8
- DialogApi 1.1
- ImageCoercion 1.1
- BindingEvents
- CompressedFile
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
Office 2016 on Windows
(volume-licensed perpetual)
- TaskPane
- Content
- ExcelApi 1.1
- DialogApi 1.1*
- ImageCoercion 1.1
- BindingEvents
- CompressedFile
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
Office 2013 on Windows
(perpetual)
- TaskPane
- Content
- DialogApi 1.1*
- ImageCoercion 1.1
- BindingEvents
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
Office on iPad
(Microsoft 365 subscription)
- TaskPane
- Content
- ExcelApi 1.1
- ExcelApi 1.2
- ExcelApi 1.3
- ExcelApi 1.4
- ExcelApi 1.5
- ExcelApi 1.6
- ExcelApi 1.7
- ExcelApi 1.8
- ExcelApi 1.9
- ExcelApi 1.10
- ExcelApi 1.11
- ExcelApi 1.12
- ExcelApi 1.13
- ExcelApi 1.14
- ExcelApi 1.15
- ExcelApi 1.16
- ExcelApi 1.17
- DialogApi 1.1
- DialogApi 1.2
- ImageCoercion 1.1
- OpenBrowserWindowApi 1.1
- BindingEvents
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
Office on Mac - TaskPane
- Content
- CustomFunctions
- Add-in Commands
- ExcelApi 1.1
- ExcelApi 1.2
- ExcelApi 1.3
- ExcelApi 1.4
- ExcelApi 1.5
- ExcelApi 1.6
- ExcelApi 1.7
- ExcelApi 1.8
- ExcelApi 1.9
- ExcelApi 1.10
- ExcelApi 1.11
- ExcelApi 1.12
- ExcelApi 1.13
- ExcelApi 1.14
- ExcelApi 1.15
- ExcelApi 1.16
- ExcelApi 1.17
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- RibbonApi 1.1
- SharedRuntime 1.1
- SharedRuntime 1.2
- KeyboardShortcuts 1.1
- BindingEvents
- CompressedFile
- DocumentEvents
- File
- MatrixBindings
- MatrixCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion

* Added with post-release updates.

Custom Functions (Excel only)

Platform Extension points API requirement sets Common APIs
Office on the web - CustomFunctions - CustomFunctionsRuntime 1.1
- CustomFunctionsRuntime 1.2
- CustomFunctionsRuntime 1.3
- CustomFunctionsRuntime 1.4
Not applicable
Office on Windows
- Microsoft 365 subscription
- retail perpetual Office 2016 and later
- CustomFunctions - CustomFunctionsRuntime 1.1
- CustomFunctionsRuntime 1.2
- CustomFunctionsRuntime 1.3
- CustomFunctionsRuntime 1.4
Not applicable
Office 2021 on Windows
(volume-licensed perpetual)
- CustomFunctions - CustomFunctionsRuntime 1.1
- CustomFunctionsRuntime 1.2
- CustomFunctionsRuntime 1.3
Not applicable
Office on Mac - CustomFunctions - CustomFunctionsRuntime 1.1
- CustomFunctionsRuntime 1.2
- CustomFunctionsRuntime 1.3
- CustomFunctionsRuntime 1.4
Not applicable

Outlook

Platform Extension points API requirement sets Common APIs
Office on the web
(modern)1 2
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Launch Event
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
- Mailbox 1.7
- Mailbox 1.8
- Mailbox 1.9
- Mailbox 1.10
- Mailbox 1.11
- Mailbox 1.12
- Mailbox 1.13
- IdentityAPI 1.33
Not available
Office on the web
(classic)2
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
Not available
Office on Windows
(new desktop client (preview))
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Launch Event
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
- Mailbox 1.7
- Mailbox 1.8
- Mailbox 1.9
- Mailbox 1.10
- Mailbox 1.11
- Mailbox 1.12
- Mailbox 1.13
- IdentityAPI 1.33
Not available
Office on Windows
- Microsoft 365 subscription
- retail perpetual Office 2016 and later
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Launch Event
- Modules
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
- Mailbox 1.7
- Mailbox 1.8
- Mailbox 1.9
- Mailbox 1.10
- Mailbox 1.11
- Mailbox 1.12
- Mailbox 1.13
- IdentityAPI 1.33
- OpenBrowserWindowApi 1.1
Not available
Office 2021 on Windows
(volume-licensed perpetual)
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Modules
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
- Mailbox 1.7
- Mailbox 1.8
- Mailbox 1.9
- IdentityAPI 1.33
- OpenBrowserWindowApi 1.1
Not available
Office 2019 on Windows
(volume-licensed perpetual)
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Modules
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
- Mailbox 1.7
Not available
Office 2016 on Windows
(volume-licensed perpetual)
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Modules
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.44
Not available
Office 2013 on Windows
(perpetual)
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.34
- Mailbox 1.44
Not available
Office on Mac
(classic UI)
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
- Mailbox 1.7
- Mailbox 1.8
- IdentityAPI 1.33
- OpenBrowserWindowApi 1.1
Not available
Office on Mac
(new UI5)
- Message Read
- Message Compose
- Appointment Attendee (Read)
- Appointment Organizer (Compose)
- Add-in Commands
- Launch Event
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
- Mailbox 1.6
- Mailbox 1.7
- Mailbox 1.8
- Mailbox 1.9
- Mailbox 1.10
- Mailbox 1.11
- Mailbox 1.12
- Mailbox 1.13
- IdentityAPI 1.33
Not available
Office on Android2 6
(Microsoft 365 subscription)
- Message Read
- Appointment Organizer (Compose): Online meeting
- Appointment Attendee (Read): Log appointment notes
- Add-in Commands
- Launch Event
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
Not available
Office on iOS2 6
(Microsoft 365 subscription)
- Message Read
- Appointment Organizer (Compose): Online meeting
- Appointment Attendee (Read): Log appointment notes
- Add-in Commands
- Launch Event
- Mailbox 1.1
- Mailbox 1.2
- Mailbox 1.3
- Mailbox 1.4
- Mailbox 1.5
Not available

Note

1 Add-ins don't work in modern Outlook on the web on iPhone and Android smartphones. For information about supported devices, see Requirements for running Office Add-ins.

2 Add-ins aren't supported in Outlook on Android, on iOS, and modern mobile web with on-premises Exchange accounts. Certain iOS devices still support add-ins when using on-premises Exchange accounts with classic Outlook on the web. For information about supported devices, see Requirements for running Office Add-ins.

3 To require the Identity API set 1.3 in your Outlook add-in code, check if it's supported by calling isSetSupported('IdentityAPI', '1.3'). Declaring it in the Outlook add-in's manifest isn't supported. You can also determine if the API is supported by checking that it's not undefined. For further details, see Using APIs from later requirement sets.

4 Added with post-release updates.

5 Support for the new Mac UI is available from Outlook Version 16.38.506. For more information, see the Add-in support in Outlook on new Mac UI section.

6 Although Outlook on Android and on iOS support up to requirement set 1.5, your mobile add-in can now implement some APIs from later requirement sets, such as APIs related to event-based activation. For more information on which APIs are supported in Outlook mobile, see Outlook JavaScript APIs supported in Outlook on mobile devices.

Important

Client support for a requirement set may be restricted by Exchange server support. See Outlook JavaScript API requirement sets for details about the range of requirement sets supported by Exchange server and Outlook clients.

Word

Platform Extension points API requirement sets Common APIs
Office on the web - TaskPane
- Add-in Commands
- WordApi 1.1
- WordApi 1.2
- WordApi 1.3
- WordApi 1.4
- WordApi 1.5
- WordApi 1.6
- WordApi 1.7
- WordApiOnline 1.1
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- BindingEvents
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile
Office on Windows
- Microsoft 365 subscription
- retail perpetual Office 2016 and later
- TaskPane
- Add-in Commands
- WordApi 1.1
- WordApi 1.2
- WordApi 1.3
- WordApi 1.4
- WordApi 1.5
- WordApi 1.6
- WordApi 1.7
- WordApiHiddenDocument 1.3
- WordApiHiddenDocument 1.4
- WordApiHiddenDocument 1.5
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- BindingEvents
- CompressedFile
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile
Office 2021 on Windows
(volume-licensed perpetual)
- TaskPane
- Add-in Commands
- WordApi 1.1
- WordApi 1.2
- WordApi 1.3
- WordApiHiddenDocument 1.3
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- BindingEvents
- CompressedFile
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile
Office 2019 on Windows
(volume-licensed perpetual)
- TaskPane
- Add-in Commands
- WordApi 1.1
- WordApi 1.2
- WordApi 1.3
- WordApiHiddenDocument 1.3
- DialogApi 1.1
- ImageCoercion 1.1
- BindingEvents
- CompressedFile
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile
Office 2016 on Windows
(volume-licensed perpetual)
- TaskPane - WordApi 1.1
- DialogApi 1.1*
- ImageCoercion 1.1
- BindingEvents
- CompressedFile
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile
Office 2013 on Windows
(perpetual)
- TaskPane - DialogApi 1.1*
- ImageCoercion 1.1
- BindingEvents
- CompressedFile
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile
Office on iPad
(Microsoft 365 subscription)
- TaskPane - WordApi 1.1
- WordApi 1.2
- WordApi 1.3
- WordApi 1.4
- WordApi 1.5
- WordApi 1.6
- WordApi 1.7
- DialogApi 1.1
- DialogApi 1.2
- ImageCoercion 1.1
- OpenBrowserWindowApi 1.1
- BindingEvents
- CompressedFile
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile
Office on Mac - TaskPane
- Add-in Commands
- WordApi 1.1
- WordApi 1.2
- WordApi 1.3
- WordApi 1.4
- WordApi 1.5
- WordApi 1.6
- WordApi 1.7
- WordApiHiddenDocument 1.3
- WordApiHiddenDocument 1.4
- WordApiHiddenDocument 1.5
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- BindingEvents
- CompressedFile
- CustomXmlParts
- DocumentEvents
- File
- HtmlCoercion
- MatrixBindings
- MatrixCoercion
- OoxmlCoercion
- PdfFile
- Selection
- Settings
- TableBindings
- TableCoercion
- TextBindings
- TextCoercion
- TextFile

* Added with post-release updates.

PowerPoint

Platform Extension points API requirement sets Common APIs
Office on the web - Content
- TaskPane
- Add-in Commands
- PowerPointApi 1.1
- PowerPointApi 1.2
- PowerPointApi 1.3
- PowerPointApi 1.4
- PowerPointApi 1.5
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion
Office on Windows
- Microsoft 365 subscription
- retail perpetual Office 2016 and later
- Content
- TaskPane
- Add-in Commands
- PowerPointApi 1.1
- PowerPointApi 1.2
- PowerPointApi 1.3
- PowerPointApi 1.4
- PowerPointApi 1.5
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion
Office 2021 on Windows
(volume-licensed perpetual)
- Content
- TaskPane
- Add-in Commands
- PowerPointApi 1.1
- PowerPointApi 1.2
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion
Office 2019 on Windows
(volume-licensed perpetual)
- Content
- TaskPane
- Add-in Commands
- DialogApi 1.1
- ImageCoercion 1.1
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion
Office 2016 on Windows
(volume-licensed perpetual)
- Content
- TaskPane
- DialogApi 1.1*
- ImageCoercion 1.1
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion
Office 2013 on Windows
(perpetual)
- Content
- TaskPane
- DialogApi 1.1*
- ImageCoercion 1.1
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion
Office on iPad
(Microsoft 365 subscription)
- Content
- TaskPane
- PowerPointApi 1.1
- DialogApi 1.1
- DialogApi 1.2
- ImageCoercion 1.1
- OpenBrowserWindowApi 1.1
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion
Office on Mac - Content
- TaskPane
- Add-in Commands
- PowerPointApi 1.1
- PowerPointApi 1.2
- PowerPointApi 1.3
- PowerPointApi 1.4
- PowerPointApi 1.5
- DialogApi 1.1
- DialogApi 1.2
- IdentityAPI 1.3
- ImageCoercion 1.1
- ImageCoercion 1.2
- OpenBrowserWindowApi 1.1
- ActiveView
- CompressedFile
- DocumentEvents
- File
- PdfFile
- Selection
- Settings
- TextCoercion

* Added with post-release updates.

OneNote

Platform Extension points API requirement sets Common APIs
Office on the web - Content
- TaskPane
- Add-in Commands
- OneNoteApi 1.1
- DialogApi 1.1
- ImageCoercion 1.1
- DocumentEvents
- HtmlCoercion
- Settings
- TextCoercion

Project

Platform Extension points API requirement sets Common APIs
Office 2021 on Windows
(volume-licensed perpetual)
- TaskPane - DialogApi 1.1 - Selection
- TextCoercion
Office 2019 on Windows
(volume-licensed perpetual)
- TaskPane - DialogApi 1.1 - Selection
- TextCoercion
Office 2016 on Windows
(volume-licensed perpetual)
- TaskPane - DialogApi 1.1 - Selection
- TextCoercion
Office 2013 on Windows
(volume-licensed perpetual)
- TaskPane - DialogApi 1.1 - Selection
- TextCoercion

See also