Skip to main content

Microsoft Teams (Service Principal)

Manage Teams, channels, members and messages across your tenant with app-only auth via an Azure AD App Registration. Grant the app Application permissions with admin consent. Note: Teams message APIs are Microsoft protected APIs and need separate app-access approval from Microsoft.

Microsoft Teams (Service Principal) Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 1020 actions:

ActionPurposeParameters
get_app_catalogs_teams_appsList apps from the Microsoft Teams app catalog, including apps from the Microsoft Teams store and apps from your organization's app catalog the tenant app catalog. To get apps from your organization's app catalog only, specify organization as the distributionMethod in the request.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_app_catalogs_teams_appsPublish an app to the Microsoft Teams app catalog. Specifically, this API publishes the app to your organization's catalog the tenant app catalog; the created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center.data required
get_app_catalogs_teams_apps_by_teams_app_idGet teamsApps from appCatalogsteamsApp-id (string) required
$select (array)
$expand (array)
patch_app_catalogs_teams_apps_by_teams_app_idUpdate the navigation property teamsApps in appCatalogsteamsApp-id (string) required
data required
delete_app_catalogs_teams_apps_by_teams_app_idDelete an app from an organization's app catalog the tenant app catalog. To delete an app, the distributionMethod property for the app must be set to organization. You can also use this API to remove a submitted app from the review process.teamsApp-id (string) required
If-Match (string)
get_app_catalogs_teams_apps_by_teams_app_id_app_definitionsThe details for each version of the app.teamsApp-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_app_catalogs_teams_apps_by_teams_app_id_app_definitionsUpdate an app previously published to the Microsoft Teams app catalog. To update an app, the distributionMethod property for the app must be set to organization. This API specifically updates an app published to your organization's app catalog the tenant app catalog.teamsApp-id (string) required
data required
get_app_catalogs_teams_apps_by_teams_app_id_app_definitions_by_teams_app_definition_idThe details for each version of the app.teamsApp-id (string) required
teamsAppDefinition-id (string) required
$select (array)
$expand (array)
patch_app_catalogs_teams_apps_by_teams_app_id_app_definitions_by_teams_app_definition_idPublish an app to the Microsoft Teams app catalog. Specifically, this API publishes the app to your organization's catalog the tenant app catalog; the created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center.teamsApp-id (string) required
teamsAppDefinition-id (string) required
data required
delete_app_catalogs_teams_apps_by_teams_app_id_app_definitions_by_teams_app_definition_idDelete navigation property appDefinitions for appCatalogsteamsApp-id (string) required
teamsAppDefinition-id (string) required
If-Match (string)
get_app_catalogs_teams_apps_by_teams_app_id_app_definitions_by_teams_app_definition_id_botGet the bot associated with a specific definition of the TeamsApp.teamsApp-id (string) required
teamsAppDefinition-id (string) required
$select (array)
$expand (array)
patch_app_catalogs_teams_apps_by_teams_app_id_app_definitions_by_teams_app_definition_id_botUpdate the navigation property bot in appCatalogsteamsApp-id (string) required
teamsAppDefinition-id (string) required
data required
delete_app_catalogs_teams_apps_by_teams_app_id_app_definitions_by_teams_app_definition_id_botDelete navigation property bot for appCatalogsteamsApp-id (string) required
teamsAppDefinition-id (string) required
If-Match (string)
get_app_catalogs_teams_apps_by_teams_app_id_app_definitions_countGet the number of the resourceteamsApp-id (string) required
$search (string)
get_app_catalogs_teams_apps_countGet the number of the resource$search (string)
get_chatsRetrieve the list of chats that the user is part of. This method supports federation. When a user ID is provided, the calling application must belong to the same tenant that the user belongs to.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chatsCreate a new chat object.data required
get_chats_by_chat_idRetrieve a single chat without its messages. This method supports federation. To access a chat, at least one chat member must belong to the tenant the request initiated from.chat-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_idUpdate the properties of a chat object.chat-id (string) required
data required
delete_chats_by_chat_idSoft-delete a chat. When invoked with delegated permissions, this operation only works for tenant admins and Teams service admins.chat-id (string) required
If-Match (string)
get_chats_by_chat_id_installed_appsList all app installations within a chat.chat-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_installed_appsInstall a teamsApp to the specified chat.chat-id (string) required
data required
get_chats_by_chat_id_installed_apps_by_teams_app_installation_idGet an app installed in a chat.chat-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_installed_apps_by_teams_app_installation_idUpdate the navigation property installedApps in chatschat-id (string) required
teamsAppInstallation-id (string) required
data required
delete_chats_by_chat_id_installed_apps_by_teams_app_installation_idUninstall an app installed within a chat.chat-id (string) required
teamsAppInstallation-id (string) required
If-Match (string)
post_chats_by_chat_id_installed_apps_by_teams_app_installation_id_upgradeUpgrade an app installation within a chat.chat-id (string) required
teamsAppInstallation-id (string) required
data: {
. consentedPermissionSet
} (object) required
get_chats_by_chat_id_installed_apps_by_teams_app_installation_id_teams_appThe app that is installed.chat-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_chats_by_chat_id_installed_apps_by_teams_app_installation_id_teams_app_definitionThe details of this version of the app.chat-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_chats_by_chat_id_installed_apps_countGet the number of the resourcechat-id (string) required
$search (string)
get_chats_by_chat_id_last_message_previewPreview of the last message sent in the chat. Null if no messages were sent in the chat. Currently, only the list chats operation supports this property.chat-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_last_message_previewUpdate the navigation property lastMessagePreview in chatschat-id (string) required
data required
delete_chats_by_chat_id_last_message_previewDelete navigation property lastMessagePreview for chatschat-id (string) required
If-Match (string)
get_chats_by_chat_id_membersList all conversation members in a chat or channel.chat-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_membersAdd a conversationMember to a chat.chat-id (string) required
data required
get_chats_by_chat_id_members_by_conversation_member_idRetrieve a conversationMember from a chat.chat-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_members_by_conversation_member_idUpdate the navigation property members in chatschat-id (string) required
conversationMember-id (string) required
data required
delete_chats_by_chat_id_members_by_conversation_member_idRemove a conversationMember from a chat.chat-id (string) required
conversationMember-id (string) required
If-Match (string)
get_chats_by_chat_id_members_countGet the number of the resourcechat-id (string) required
$search (string)
post_chats_by_chat_id_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.chat-id (string) required
data: {
. values (array)
} (object) required
post_chats_by_chat_id_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.chat-id (string) required
data: {
. values (array)
} (object) required
get_chats_by_chat_id_messagesRetrieve the list of messages in a chat. This method supports federation. To list chat messages in application context, the request must be made from the tenant that the channel owner belongs to represented by the tenantId property on the channel.chat-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_messagesSend a new chatMessage in the specified chat. This API can't create a new chat; you must use the list chats method to retrieve the ID of an existing chat before you can create a chat message.chat-id (string) required
data required
get_chats_by_chat_id_messages_by_chat_message_idRetrieve a single message or a message reply in a channel or a chat.chat-id (string) required
chatMessage-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_messages_by_chat_message_idUpdate the navigation property messages in chatschat-id (string) required
chatMessage-id (string) required
data required
delete_chats_by_chat_id_messages_by_chat_message_idDelete navigation property messages for chatschat-id (string) required
chatMessage-id (string) required
If-Match (string)
get_chats_by_chat_id_messages_by_chat_message_id_hosted_contentsRetrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.chat-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_messages_by_chat_message_id_hosted_contentsCreate new navigation property to hostedContents for chatschat-id (string) required
chatMessage-id (string) required
data required
get_chats_by_chat_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idRetrieve the properties and relationships of chatMessageHostedContent object.chat-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in chatschat-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data required
delete_chats_by_chat_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for chatschat-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_chats_by_chat_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueRetrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.chat-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
put_chats_by_chat_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.chat-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_chats_by_chat_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.chat-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_chats_by_chat_id_messages_by_chat_message_id_hosted_contents_countGet the number of the resourcechat-id (string) required
chatMessage-id (string) required
$search (string)
post_chats_by_chat_id_messages_by_chat_message_id_set_reactionInvoke action setReactionchat-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
post_chats_by_chat_id_messages_by_chat_message_id_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.chat-id (string) required
chatMessage-id (string) required
post_chats_by_chat_id_messages_by_chat_message_id_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.chat-id (string) required
chatMessage-id (string) required
post_chats_by_chat_id_messages_by_chat_message_id_unset_reactionInvoke action unsetReactionchat-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
get_chats_by_chat_id_messages_by_chat_message_id_repliesReplies for a specified message. Supports $expand for channel messages.chat-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_messages_by_chat_message_id_repliesCreate new navigation property to replies for chatschat-id (string) required
chatMessage-id (string) required
data required
get_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1Replies for a specified message. Supports $expand for channel messages.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1Update the navigation property replies in chatschat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
delete_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1Delete navigation property replies for chatschat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
If-Match (string)
get_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsContent in a message hosted by Microsoft Teams - for example, images or code snippets.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsCreate new navigation property to hostedContents for chatschat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
get_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idContent in a message hosted by Microsoft Teams - for example, images or code snippets.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in chatschat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data required
delete_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for chatschat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
put_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_countGet the number of the resourcechat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$search (string)
post_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_set_reactionInvoke action setReactionchat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
post_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.chat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_chats_by_chat_id_messages_by_chat_message_id_replies_by_chat_message_id1_unset_reactionInvoke action unsetReactionchat-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
get_chats_by_chat_id_messages_by_chat_message_id_replies_countGet the number of the resourcechat-id (string) required
chatMessage-id (string) required
$search (string)
get_chats_by_chat_id_messages_by_chat_message_id_replies_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLichat-id (string) required
chatMessage-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_chats_by_chat_id_messages_countGet the number of the resourcechat-id (string) required
$search (string)
get_chats_by_chat_id_messages_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLichat-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
post_chats_by_chat_id_hide_for_userHide a chat for a user.chat-id (string) required
data: {
. user
} (object) required
post_chats_by_chat_id_mark_chat_read_for_userMark a chat as read for a user.chat-id (string) required
data: {
. user
} (object) required
post_chats_by_chat_id_mark_chat_unread_for_userMark a chat as unread for a user.chat-id (string) required
data: {
. user
. lastMessageReadDateTime (string)
} (object) required
post_chats_by_chat_id_remove_all_access_for_userRemove access to a chat for a user.chat-id (string) required
data: {
. user
} (object) required
post_chats_by_chat_id_send_activity_notificationSend an activity feed notification in scope of a chat. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.chat-id (string) required
data: {
. topic
. activityType (string)
. chainId (number)
. previewText
. teamsAppId (string)
. templateParameters (array)
. recipient
. iconId (string)
} (object) required
post_chats_by_chat_id_unhide_for_userUnhide a chat for a user.chat-id (string) required
data: {
. user
} (object) required
get_chats_by_chat_id_permission_grantsList all resource-specific permission grants on the chat. This list specifies the Microsoft Entra apps that have access to the chat, along with the corresponding resource-specific access that each app has.chat-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_permission_grantsCreate new navigation property to permissionGrants for chatschat-id (string) required
data required
get_chats_by_chat_id_permission_grants_by_resource_specific_permission_grant_idA collection of permissions granted to apps for the chat.chat-id (string) required
resourceSpecificPermissionGrant-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_permission_grants_by_resource_specific_permission_grant_idUpdate the navigation property permissionGrants in chatschat-id (string) required
resourceSpecificPermissionGrant-id (string) required
data required
delete_chats_by_chat_id_permission_grants_by_resource_specific_permission_grant_idDelete navigation property permissionGrants for chatschat-id (string) required
resourceSpecificPermissionGrant-id (string) required
If-Match (string)
get_chats_by_chat_id_permission_grants_countGet the number of the resourcechat-id (string) required
$search (string)
get_chats_by_chat_id_pinned_messagesGet a list of pinnedChatMessages in a chat.chat-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_pinned_messagesPin a chat message in the specified chat. This API cannot create a new chat; you must use the list chats method to retrieve the ID of an existing chat before you can pin a chat message.chat-id (string) required
data required
get_chats_by_chat_id_pinned_messages_by_pinned_chat_message_info_idA collection of all the pinned messages in the chat. Nullable.chat-id (string) required
pinnedChatMessageInfo-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_pinned_messages_by_pinned_chat_message_info_idUpdate the navigation property pinnedMessages in chatschat-id (string) required
pinnedChatMessageInfo-id (string) required
data required
delete_chats_by_chat_id_pinned_messages_by_pinned_chat_message_info_idUnpin a message from a chat.chat-id (string) required
pinnedChatMessageInfo-id (string) required
If-Match (string)
get_chats_by_chat_id_pinned_messages_by_pinned_chat_message_info_id_messageRepresents details about the chat message that is pinned.chat-id (string) required
pinnedChatMessageInfo-id (string) required
$select (array)
$expand (array)
get_chats_by_chat_id_pinned_messages_countGet the number of the resourcechat-id (string) required
$search (string)
get_chats_by_chat_id_tabsRetrieve the list of tabs in the specified chat.chat-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_chats_by_chat_id_tabsAdd pin a tab to the specified chat. The corresponding app must already be installed in the chat.chat-id (string) required
data required
get_chats_by_chat_id_tabs_by_teams_tab_idRetrieve the properties and relationships of the specified tab in a chat.chat-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
patch_chats_by_chat_id_tabs_by_teams_tab_idUpdate the properties of the specified tab in a chat. This can be used to configure the content of the tab.chat-id (string) required
teamsTab-id (string) required
data required
delete_chats_by_chat_id_tabs_by_teams_tab_idRemove unpin a tab from the specified chat.chat-id (string) required
teamsTab-id (string) required
If-Match (string)
get_chats_by_chat_id_tabs_by_teams_tab_id_teams_appThe application that is linked to the tab. This can't be changed after tab creation.chat-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
get_chats_by_chat_id_tabs_countGet the number of the resourcechat-id (string) required
$search (string)
get_chats_countGet the number of the resource$search (string)
get_chats_get_all_messages_Get all messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.model (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_chats_get_all_retained_messages_Get all retained messages from all chats that a user is a participant in, including one-on-one chats, group chats, and meeting chats. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_communicationsGet communications$select (array)
$expand (array)
patch_communicationsUpdate communicationsdata: {
. callRecords (array)
. calls (array)
. onlineMeetingConversations (array)
. onlineMeetings (array)
. presences (array)
. @odata.type (string)
} (object) required
get_communications_call_recordsGet the list of callRecord objects and their properties. The results can be optionally filtered using the $filter query parameter on the startDateTime and participant id properties. Note that the listed call records don't include expandable relationships such as sessions and participants_v2. You can expand these relationships using Get callRecord for a specific record.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_call_recordsCreate new navigation property to callRecords for communicationsdata required
get_communications_call_records_by_call_record_idRetrieve the properties and relationships of a callRecord object. You can get the id of a callRecord in two ways: Subscribe to change notifications to the /communications/callRecords endpoint. Use the callChainId property of a call. The call record is available only after the associated call is completed.callRecord-id (string) required
$select (array)
$expand (array)
patch_communications_call_records_by_call_record_idUpdate the navigation property callRecords in communicationscallRecord-id (string) required
data required
delete_communications_call_records_by_call_record_idDelete navigation property callRecords for communicationscallRecord-id (string) required
If-Match (string)
get_communications_call_records_by_call_record_id_organizer_v2Identity of the organizer of the call. This relationship is expanded by default in callRecord methods.callRecord-id (string) required
$select (array)
$expand (array)
patch_communications_call_records_by_call_record_id_organizer_v2Update the navigation property organizer_v2 in communicationscallRecord-id (string) required
data required
delete_communications_call_records_by_call_record_id_organizer_v2Delete navigation property organizer_v2 for communicationscallRecord-id (string) required
If-Match (string)
get_communications_call_records_by_call_record_id_participants_v2Get the list of participant objects associated with a callRecord.callRecord-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_call_records_by_call_record_id_participants_v2Create new navigation property to participants_v2 for communicationscallRecord-id (string) required
data required
get_communications_call_records_by_call_record_id_participants_v2_by_participant_idList of distinct participants in the call.callRecord-id (string) required
participant-id (string) required
$select (array)
$expand (array)
patch_communications_call_records_by_call_record_id_participants_v2_by_participant_idUpdate the navigation property participants_v2 in communicationscallRecord-id (string) required
participant-id (string) required
data required
delete_communications_call_records_by_call_record_id_participants_v2_by_participant_idDelete navigation property participants_v2 for communicationscallRecord-id (string) required
participant-id (string) required
If-Match (string)
get_communications_call_records_by_call_record_id_participants_v2_countGet the number of the resourcecallRecord-id (string) required
$search (string)
get_communications_call_records_by_call_record_id_sessionsRetrieve the list of sessions associated with a callRecord object. If the sessions list is truncated, a sessions@odata.nextLink value will be provided to retrieve the next page of sessions. The maximum page size for sessions is 60 entries.callRecord-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_call_records_by_call_record_id_sessionsCreate new navigation property to sessions for communicationscallRecord-id (string) required
data required
get_communications_call_records_by_call_record_id_sessions_by_session_idList of sessions involved in the call. Peer-to-peer calls typically only have one session, whereas group calls typically have at least one session per participant. Read-only. Nullable.callRecord-id (string) required
session-id (string) required
$select (array)
$expand (array)
patch_communications_call_records_by_call_record_id_sessions_by_session_idUpdate the navigation property sessions in communicationscallRecord-id (string) required
session-id (string) required
data required
delete_communications_call_records_by_call_record_id_sessions_by_session_idDelete navigation property sessions for communicationscallRecord-id (string) required
session-id (string) required
If-Match (string)
get_communications_call_records_by_call_record_id_sessions_by_session_id_segmentsThe list of segments involved in the session. Read-only. Nullable.callRecord-id (string) required
session-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_call_records_by_call_record_id_sessions_by_session_id_segmentsCreate new navigation property to segments for communicationscallRecord-id (string) required
session-id (string) required
data required
get_communications_call_records_by_call_record_id_sessions_by_session_id_segments_by_segment_idThe list of segments involved in the session. Read-only. Nullable.callRecord-id (string) required
session-id (string) required
segment-id (string) required
$select (array)
$expand (array)
patch_communications_call_records_by_call_record_id_sessions_by_session_id_segments_by_segment_idUpdate the navigation property segments in communicationscallRecord-id (string) required
session-id (string) required
segment-id (string) required
data required
delete_communications_call_records_by_call_record_id_sessions_by_session_id_segments_by_segment_idDelete navigation property segments for communicationscallRecord-id (string) required
session-id (string) required
segment-id (string) required
If-Match (string)
get_communications_call_records_by_call_record_id_sessions_by_session_id_segments_countGet the number of the resourcecallRecord-id (string) required
session-id (string) required
$search (string)
get_communications_call_records_by_call_record_id_sessions_countGet the number of the resourcecallRecord-id (string) required
$search (string)
get_communications_call_records_countGet the number of the resource$search (string)
get_communications_call_records_microsoft_graph_call_records_get_direct_routing_calls_from_date_time_by_from_date_time_to_date_time_by_to_date_time_Get a log of direct routing calls as a collection of directRoutingLogRow entries.fromDateTime (string) required
toDateTime (string) required
$top (integer)
get_communications_call_records_microsoft_graph_call_records_get_pstn_calls_from_date_time_by_from_date_time_to_date_time_by_to_date_time_Get a log of PSTN calls as a collection of pstnCallLogRow entries.fromDateTime (string) required
toDateTime (string) required
$top (integer)
get_communications_callsRetrieve the properties and relationships of a call object.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_callsCreate call enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. You need to register the calling bot and go through the list of permissions needed. This API supports the following PSTN scenarios:data required
get_communications_calls_by_call_idRetrieve the properties and relationships of a call object.call-id (string) required
$select (array)
$expand (array)
patch_communications_calls_by_call_idUpdate the navigation property calls in communicationscall-id (string) required
data required
delete_communications_calls_by_call_idDelete or hang up an active call. For group calls, this will only delete your call leg and the underlying group call will still continue.call-id (string) required
If-Match (string)
get_communications_calls_by_call_id_audio_routing_groupsRetrieve a list of audioRoutingGroup objects.call-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_calls_by_call_id_audio_routing_groupsCreate a new audioRoutingGroup.call-id (string) required
data required
get_communications_calls_by_call_id_audio_routing_groups_by_audio_routing_group_idRetrieve the properties and relationships of an audioRoutingGroup object.call-id (string) required
audioRoutingGroup-id (string) required
$select (array)
$expand (array)
patch_communications_calls_by_call_id_audio_routing_groups_by_audio_routing_group_idModify sources and receivers of an audioRoutingGroup.call-id (string) required
audioRoutingGroup-id (string) required
data required
delete_communications_calls_by_call_id_audio_routing_groups_by_audio_routing_group_idDelete the specified audioRoutingGroup.call-id (string) required
audioRoutingGroup-id (string) required
If-Match (string)
get_communications_calls_by_call_id_audio_routing_groups_countGet the number of the resourcecall-id (string) required
$search (string)
get_communications_calls_by_call_id_content_sharing_sessionsRetrieve a list of contentSharingSession objects in a call.call-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_calls_by_call_id_content_sharing_sessionsCreate new navigation property to contentSharingSessions for communicationscall-id (string) required
data required
get_communications_calls_by_call_id_content_sharing_sessions_by_content_sharing_session_idRetrieve the properties of a contentSharingSession object in a call.call-id (string) required
contentSharingSession-id (string) required
$select (array)
$expand (array)
patch_communications_calls_by_call_id_content_sharing_sessions_by_content_sharing_session_idUpdate the navigation property contentSharingSessions in communicationscall-id (string) required
contentSharingSession-id (string) required
data required
delete_communications_calls_by_call_id_content_sharing_sessions_by_content_sharing_session_idDelete navigation property contentSharingSessions for communicationscall-id (string) required
contentSharingSession-id (string) required
If-Match (string)
get_communications_calls_by_call_id_content_sharing_sessions_countGet the number of the resourcecall-id (string) required
$search (string)
post_communications_calls_by_call_id_add_large_gallery_viewAdd the large gallery view to a call. For details about how to identify a large gallery view participant in a roster so that you can retrieve the relevant data to subscribe to the video feed, see Identify large gallery view participants in a roster.call-id (string) required
data: {
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_answerEnable a bot to answer an incoming call. The incoming call request can be an invitation from a participant in a group call or a peer-to-peer call. If an invitation to a group call is received, the notification contains the chatInfo and meetingInfo parameters. The bot is expected to answer, reject, or redirect the call before the call times out. The current timeout value is 15 seconds for regular scenarios and 5 seconds for policy-based recording scenarios. This API supports the following PSTN sccall-id (string) required
data: {
. callbackUri (string)
. mediaConfig (object)
. acceptedModalities (array)
. participantCapacity (number)
. callOptions
} (object) required
post_communications_calls_by_call_id_cancel_media_processingCancels processing for any in-progress media operations. Media operations refer to the IVR operations playPrompt and recordResponse, which are by default queued to process in order. The cancelMediaProcessing method cancels any operation that is in-process as well as operations that are queued. For example, this method can be used to clean up the IVR operation queue for a new media operation. However, it will not cancel a subscribeToTone operation because it operates independent of any operationcall-id (string) required
data: {
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_change_screen_sharing_roleAllow applications to share screen content with the participants of a group call.call-id (string) required
data: {
. role (string)
} (object) required
post_communications_calls_by_call_id_keep_aliveMake a request to this API every 15 to 45 minutes to ensure that an ongoing call remains active. A call that does not receive this request within 45 minutes is considered inactive and will subsequently end. At least one successful request must be made within 45 minutes of the previous request, or the start of the call. We recommend that you send a request in shorter time intervals every 15 minutes. Make sure that these requests are successful to prevent the call from timing out and ending. Attemcall-id (string) required
post_communications_calls_by_call_id_muteAllows the application to mute itself. This is a server mute, meaning that the server will drop all audio packets for this participant, even if the participant continues to stream audio. For more details about how to handle mute operations, see muteParticipantOperationcall-id (string) required
data: {
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_play_promptPlay a prompt in the call. For more information about how to handle operations, see commsOperationcall-id (string) required
data: {
. prompts (array)
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_record_responseRecords a short audio response from the caller. A bot can utilize this to capture a voice response from a caller after they are prompted for a response. For further information on how to handle operations, please review commsOperation This action is not intended to record the entire call. The maximum length of recording is 2 minutes. The recording is not saved permanently by the Cloud Communications Platform and is discarded shortly after the call ends. The bot must download the recording prompcall-id (string) required
data: {
. prompts (array)
. bargeInAllowed (boolean)
. initialSilenceTimeoutInSeconds (number)
. maxSilenceTimeoutInSeconds (number)
. maxRecordDurationInSeconds (number)
. playBeep (boolean)
. stopTones (array)
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_redirectRedirect an incoming call that hasn't been answered or rejected yet. The terms 'redirecting' and 'forwarding' a call are used interchangeably. The bot is expected to redirect the call before the call times out. The current timeout value is 15 seconds.call-id (string) required
data: {
. targets (array)
. timeout (number)
. callbackUri (string)
} (object) required
post_communications_calls_by_call_id_rejectEnable a bot to reject an incoming call. The incoming call request can be an invite from a participant in a group call or a peer-to-peer call. If an invite to a group call is received, the notification will contain the chatInfo and meetingInfo parameters. The bot is expected to answer or reject the call before the call times out. The current timeout value is 15 seconds. This API does not end existing calls that have already been answered. Use delete call to end a call.call-id (string) required
data: {
. reason
. callbackUri (string)
} (object) required
post_communications_calls_by_call_id_send_dtmf_tonesInvoke action sendDtmfTonescall-id (string) required
data: {
. tones (array)
. delayBetweenTonesMs (number)
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_subscribe_to_toneSubscribe to DTMF dual-tone multi-frequency signaling which allows you to be notified when the user presses keys on a 'dialpad'.call-id (string) required
data: {
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_transferTransfer an active peer-to-peer call or group call. A consultative transfer means that the transferor can inform the person they want to transfer the call to the transferee, before the transfer is made. This is opposed to transfering the call directly.call-id (string) required
data: {
. transferTarget (object)
. transferee
} (object) required
post_communications_calls_by_call_id_unmuteAllow the application to unmute itself. This is a server unmute, meaning that the server will start sending audio packets for this participant to other participants again. For more information about how to handle unmute operations, see unmuteParticipantOperation.call-id (string) required
data: {
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_update_recording_statusUpdate the application's recording status associated with a call. This requires the use of the Teams policy-based recording solution.call-id (string) required
data: {
. status (string)
. clientContext (string)
} (object) required
get_communications_calls_by_call_id_operationsGet the status of an operation that adds the large gallery view to a call.call-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_calls_by_call_id_operationsCreate new navigation property to operations for communicationscall-id (string) required
data required
get_communications_calls_by_call_id_operations_by_comms_operation_idGet the status of an operation that adds the large gallery view to a call.call-id (string) required
commsOperation-id (string) required
$select (array)
$expand (array)
patch_communications_calls_by_call_id_operations_by_comms_operation_idUpdate the navigation property operations in communicationscall-id (string) required
commsOperation-id (string) required
data required
delete_communications_calls_by_call_id_operations_by_comms_operation_idDelete navigation property operations for communicationscall-id (string) required
commsOperation-id (string) required
If-Match (string)
get_communications_calls_by_call_id_operations_countGet the number of the resourcecall-id (string) required
$search (string)
get_communications_calls_by_call_id_participantsRetrieve a list of participant objects in the call.call-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_calls_by_call_id_participantsCreate new navigation property to participants for communicationscall-id (string) required
data required
get_communications_calls_by_call_id_participants_by_participant_idRetrieve the properties and relationships of a participant object.call-id (string) required
participant-id (string) required
$select (array)
$expand (array)
patch_communications_calls_by_call_id_participants_by_participant_idUpdate the navigation property participants in communicationscall-id (string) required
participant-id (string) required
data required
delete_communications_calls_by_call_id_participants_by_participant_idDelete a specific participant in a call. In some situations, it is appropriate for an application to remove a participant from an active call. This action can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call with no pre- or post-removal notification. When an invited participant is removed, any outstanding add participant request is canceled.call-id (string) required
participant-id (string) required
If-Match (string)
post_communications_calls_by_call_id_participants_by_participant_id_muteMute a specific participant in the call. This is a server mute, meaning that the server will drop all audio packets for this participant, even if the participant continues to stream audio. For more information about how to handle mute operations, see muteParticipantOperation.call-id (string) required
participant-id (string) required
data: {
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_participants_by_participant_id_start_hold_musicPut a participant on hold and play music in the background.call-id (string) required
participant-id (string) required
data: {
. customPrompt
. clientContext (string)
} (object) required
post_communications_calls_by_call_id_participants_by_participant_id_stop_hold_musicReincorporate a participant previously put on hold to the call.call-id (string) required
participant-id (string) required
data: {
. clientContext (string)
} (object) required
get_communications_calls_by_call_id_participants_countGet the number of the resourcecall-id (string) required
$search (string)
post_communications_calls_by_call_id_participants_inviteDelete a specific participant in a call. In some situations, it is appropriate for an application to remove a participant from an active call. This action can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call with no pre- or post-removal notification. When an invited participant is removed, any outstanding add participant request is canceled.call-id (string) required
data: {
. participants (array)
. clientContext (string)
} (object) required
get_communications_calls_countGet the number of the resource$search (string)
post_communications_calls_log_teleconference_device_qualityLog video teleconferencing device quality data. The Cloud Video Interop CVI bot represents video teleconferencing VTC devices and acts as a back-to-back agent for a VTC device in a conference call. Because a CVI bot is in the middle of the VTC and Microsoft Teams infrastructure as a VTC proxy, it has two media legs. One media leg is between the CVI bot and Teams infrastructure, such as Teams conference server or a Teams client. The other media leg is between the CVI bot and the VTC device. Thedata: {
. quality (object)
} (object) required
get_communications_get_all_online_meeting_messages_Get all Teams question and answer Q and A conversation messages in a tenant. This function returns a snapshot of all Q and A activity in JSON format. The export includes: - The original question or discussion text - The user who posted the message - All replies and responders - Vote counts - Moderation status pending or dismissed - Private replies - The meeting ID and organizer ID that are used for mapping to meeting metadata.$top (integer)
$select (array)
$orderby (array)
$expand (array)
post_communications_get_presences_by_user_idGet the presence information for multiple users.data: {
. ids (array)
} (object) required
get_communications_online_meeting_conversationsA collection of structured question-and-answer Q and A threads in Teams directly associated with online meetings.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversationsCreate new navigation property to onlineMeetingConversations for communicationsdata required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_idA collection of structured question-and-answer Q and A threads in Teams directly associated with online meetings.onlineMeetingEngagementConversation-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_idUpdate the navigation property onlineMeetingConversations in communicationsonlineMeetingEngagementConversation-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_idDelete navigation property onlineMeetingConversations for communicationsonlineMeetingEngagementConversation-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messagesThe messages in a Viva Engage conversation.onlineMeetingEngagementConversation-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messagesCreate new navigation property to messages for communicationsonlineMeetingEngagementConversation-id (string) required
data required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_idThe messages in a Viva Engage conversation.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_idUpdate the navigation property messages in communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_idDelete navigation property messages for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_conversationThe Viva Engage conversation to which this message belongs. This relationship establishes the thread context for the message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_reactionsGet a list of the engagementConversationMessageReaction objects and their properties for an engagementConversationMessage in an online meeting.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_reactionsCreate new navigation property to reactions for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
data required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_reactions_by_engagement_conversation_message_reaction_idA collection of reactions such as like and smile that users have applied to this message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessageReaction-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_reactions_by_engagement_conversation_message_reaction_idUpdate the navigation property reactions in communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessageReaction-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_reactions_by_engagement_conversation_message_reaction_idDelete navigation property reactions for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessageReaction-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_reactions_countGet the number of the resourceonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$search (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_repliesA collection of messages that are replies to this message and form a threaded discussion.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_repliesCreate new navigation property to replies for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
data required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1A collection of messages that are replies to this message and form a threaded discussion.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1Update the navigation property replies in communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1Delete navigation property replies for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_conversationThe Viva Engage conversation to which this message belongs. This relationship establishes the thread context for the message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_reactionsA collection of reactions such as like and smile that users have applied to this message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_reactionsCreate new navigation property to reactions for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
data required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_reactions_by_engagement_conversation_message_reaction_idA collection of reactions such as like and smile that users have applied to this message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
engagementConversationMessageReaction-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_reactions_by_engagement_conversation_message_reaction_idUpdate the navigation property reactions in communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
engagementConversationMessageReaction-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_reactions_by_engagement_conversation_message_reaction_idDelete navigation property reactions for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
engagementConversationMessageReaction-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_reactions_countGet the number of the resourceonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
$search (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_by_engagement_conversation_message_id1_reply_toThe parent message to which this message is a reply, if it is part of a reply chain.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessage-id1 (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_replies_countGet the number of the resourceonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$search (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_by_engagement_conversation_message_id_reply_toThe parent message to which this message is a reply, if it is part of a reply chain.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_messages_countGet the number of the resourceonlineMeetingEngagementConversation-id (string) required
$search (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_online_meetingThe online meeting associated with the conversation.onlineMeetingEngagementConversation-id (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_online_meeting_attendee_reportThe content stream of the attendee report of a Microsoft Teams live event. Read-only.onlineMeetingEngagementConversation-id (string) required
put_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_online_meeting_attendee_reportThe content stream of the attendee report of a Microsoft Teams live event. Read-only.onlineMeetingEngagementConversation-id (string) required
data (string) required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_online_meeting_attendee_reportThe content stream of the attendee report of a Microsoft Teams live event. Read-only.onlineMeetingEngagementConversation-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starterThe first message in a Viva Engage conversation.onlineMeetingEngagementConversation-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starterUpdate the navigation property starter in communicationsonlineMeetingEngagementConversation-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starterDelete navigation property starter for communicationsonlineMeetingEngagementConversation-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_conversationThe Viva Engage conversation to which this message belongs. This relationship establishes the thread context for the message.onlineMeetingEngagementConversation-id (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_reactionsA collection of reactions such as like and smile that users have applied to this message.onlineMeetingEngagementConversation-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_reactionsCreate new navigation property to reactions for communicationsonlineMeetingEngagementConversation-id (string) required
data required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_reactions_by_engagement_conversation_message_reaction_idA collection of reactions such as like and smile that users have applied to this message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessageReaction-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_reactions_by_engagement_conversation_message_reaction_idUpdate the navigation property reactions in communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessageReaction-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_reactions_by_engagement_conversation_message_reaction_idDelete navigation property reactions for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessageReaction-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_reactions_countGet the number of the resourceonlineMeetingEngagementConversation-id (string) required
$search (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_repliesA collection of messages that are replies to this message and form a threaded discussion.onlineMeetingEngagementConversation-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_repliesCreate new navigation property to replies for communicationsonlineMeetingEngagementConversation-id (string) required
data required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_idA collection of messages that are replies to this message and form a threaded discussion.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_idUpdate the navigation property replies in communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_idDelete navigation property replies for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_conversationThe Viva Engage conversation to which this message belongs. This relationship establishes the thread context for the message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_reactionsA collection of reactions such as like and smile that users have applied to this message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_reactionsCreate new navigation property to reactions for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
data required
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_reactions_by_engagement_conversation_message_reaction_idA collection of reactions such as like and smile that users have applied to this message.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessageReaction-id (string) required
$select (array)
$expand (array)
patch_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_reactions_by_engagement_conversation_message_reaction_idUpdate the navigation property reactions in communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessageReaction-id (string) required
data required
delete_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_reactions_by_engagement_conversation_message_reaction_idDelete navigation property reactions for communicationsonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
engagementConversationMessageReaction-id (string) required
If-Match (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_reactions_countGet the number of the resourceonlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$search (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_by_engagement_conversation_message_id_reply_toThe parent message to which this message is a reply, if it is part of a reply chain.onlineMeetingEngagementConversation-id (string) required
engagementConversationMessage-id (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_replies_countGet the number of the resourceonlineMeetingEngagementConversation-id (string) required
$search (string)
get_communications_online_meeting_conversations_by_online_meeting_engagement_conversation_id_starter_reply_toThe parent message to which this message is a reply, if it is part of a reply chain.onlineMeetingEngagementConversation-id (string) required
$select (array)
$expand (array)
get_communications_online_meeting_conversations_countGet the number of the resource$search (string)
get_communications_online_meetingsRetrieve the properties and relationships of an onlineMeeting object. For example, you can: Teams live event attendee report deprecated and Teams live event recordings deprecated are online meeting artifacts. For more information, see Online meeting artifacts and permissions.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meetingsCreate new navigation property to onlineMeetings for communicationsdata required
get_communications_online_meetings_by_online_meeting_idGet onlineMeetings from communicationsonlineMeeting-id (string) required
$select (array)
$expand (array)
patch_communications_online_meetings_by_online_meeting_idUpdate the navigation property onlineMeetings in communicationsonlineMeeting-id (string) required
data required
delete_communications_online_meetings_by_online_meeting_idDelete navigation property onlineMeetings for communicationsonlineMeeting-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_attendance_reportsThe attendance reports of an online meeting. Read-only.onlineMeeting-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meetings_by_online_meeting_id_attendance_reportsCreate new navigation property to attendanceReports for communicationsonlineMeeting-id (string) required
data required
get_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_idThe attendance reports of an online meeting. Read-only.onlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
$select (array)
$expand (array)
patch_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_idUpdate the navigation property attendanceReports in communicationsonlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
data required
delete_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_idDelete navigation property attendanceReports for communicationsonlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_id_attendance_recordsList of attendance records of an attendance report. Read-only.onlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_id_attendance_recordsCreate new navigation property to attendanceRecords for communicationsonlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
data required
get_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_id_attendance_records_by_attendance_record_idList of attendance records of an attendance report. Read-only.onlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
attendanceRecord-id (string) required
$select (array)
$expand (array)
patch_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_id_attendance_records_by_attendance_record_idUpdate the navigation property attendanceRecords in communicationsonlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
attendanceRecord-id (string) required
data required
delete_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_id_attendance_records_by_attendance_record_idDelete navigation property attendanceRecords for communicationsonlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
attendanceRecord-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_attendance_reports_by_meeting_attendance_report_id_attendance_records_countGet the number of the resourceonlineMeeting-id (string) required
meetingAttendanceReport-id (string) required
$search (string)
get_communications_online_meetings_by_online_meeting_id_attendance_reports_countGet the number of the resourceonlineMeeting-id (string) required
$search (string)
get_communications_online_meetings_by_online_meeting_id_attendee_reportThe content stream of the attendee report of a Microsoft Teams live event. Read-only.onlineMeeting-id (string) required
put_communications_online_meetings_by_online_meeting_id_attendee_reportThe content stream of the attendee report of a Microsoft Teams live event. Read-only.onlineMeeting-id (string) required
data (string) required
delete_communications_online_meetings_by_online_meeting_id_attendee_reportThe content stream of the attendee report of a Microsoft Teams live event. Read-only.onlineMeeting-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_get_virtual_appointment_join_web_url_Get a join web URL for a Microsoft Virtual Appointment. This web URL includes enhanced business-to-customer experiences such as mobile browser join and virtual lobby rooms. With Teams Premium, you can configure a custom lobby room experience for attendees by adding your company logo and access the Virtual Appointments usage report for organizational analytics.onlineMeeting-id (string) required
post_communications_online_meetings_by_online_meeting_id_send_virtual_appointment_reminder_smsSend an SMS reminder to external attendees for a Teams virtual appointment. This feature requires Teams premium and attendees must have a valid United States phone number to receive SMS notifications.onlineMeeting-id (string) required
data: {
. remindBeforeTimeInMinutesType
. attendees (array)
} (object) required
post_communications_online_meetings_by_online_meeting_id_send_virtual_appointment_smsSend an SMS notification to external attendees when a Teams virtual appointment is confirmed, rescheduled, or canceled. This feature requires Teams premium. Attendees must have a valid United States phone number to receive these SMS notifications.onlineMeeting-id (string) required
data: {
. messageType
. attendees (array)
} (object) required
get_communications_online_meetings_by_online_meeting_id_recordingsThe recordings of an online meeting. Read-only.onlineMeeting-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meetings_by_online_meeting_id_recordingsCreate new navigation property to recordings for communicationsonlineMeeting-id (string) required
data required
get_communications_online_meetings_by_online_meeting_id_recordings_by_call_recording_idThe recordings of an online meeting. Read-only.onlineMeeting-id (string) required
callRecording-id (string) required
$select (array)
$expand (array)
patch_communications_online_meetings_by_online_meeting_id_recordings_by_call_recording_idUpdate the navigation property recordings in communicationsonlineMeeting-id (string) required
callRecording-id (string) required
data required
delete_communications_online_meetings_by_online_meeting_id_recordings_by_call_recording_idDelete navigation property recordings for communicationsonlineMeeting-id (string) required
callRecording-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_recordings_by_call_recording_id_contentThe content of the recording. Read-only.onlineMeeting-id (string) required
callRecording-id (string) required
put_communications_online_meetings_by_online_meeting_id_recordings_by_call_recording_id_contentThe content of the recording. Read-only.onlineMeeting-id (string) required
callRecording-id (string) required
data (string) required
delete_communications_online_meetings_by_online_meeting_id_recordings_by_call_recording_id_contentThe content of the recording. Read-only.onlineMeeting-id (string) required
callRecording-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_recordings_countGet the number of the resourceonlineMeeting-id (string) required
$search (string)
get_communications_online_meetings_by_online_meeting_id_recordings_delta_Invoke function deltaonlineMeeting-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_communications_online_meetings_by_online_meeting_id_transcriptsThe transcripts of an online meeting. Read-only.onlineMeeting-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_online_meetings_by_online_meeting_id_transcriptsCreate new navigation property to transcripts for communicationsonlineMeeting-id (string) required
data required
get_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_idThe transcripts of an online meeting. Read-only.onlineMeeting-id (string) required
callTranscript-id (string) required
$select (array)
$expand (array)
patch_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_idUpdate the navigation property transcripts in communicationsonlineMeeting-id (string) required
callTranscript-id (string) required
data required
delete_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_idDelete navigation property transcripts for communicationsonlineMeeting-id (string) required
callTranscript-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_id_contentThe content of the transcript. Read-only.onlineMeeting-id (string) required
callTranscript-id (string) required
put_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_id_contentThe content of the transcript. Read-only.onlineMeeting-id (string) required
callTranscript-id (string) required
data (string) required
delete_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_id_contentThe content of the transcript. Read-only.onlineMeeting-id (string) required
callTranscript-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_id_metadata_contentThe time-aligned metadata of the utterances in the transcript. Read-only.onlineMeeting-id (string) required
callTranscript-id (string) required
put_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_id_metadata_contentThe time-aligned metadata of the utterances in the transcript. Read-only.onlineMeeting-id (string) required
callTranscript-id (string) required
data (string) required
delete_communications_online_meetings_by_online_meeting_id_transcripts_by_call_transcript_id_metadata_contentThe time-aligned metadata of the utterances in the transcript. Read-only.onlineMeeting-id (string) required
callTranscript-id (string) required
If-Match (string)
get_communications_online_meetings_by_online_meeting_id_transcripts_countGet the number of the resourceonlineMeeting-id (string) required
$search (string)
get_communications_online_meetings_by_online_meeting_id_transcripts_delta_Invoke function deltaonlineMeeting-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_communications_online_meetings_countGet the number of the resource$search (string)
post_communications_online_meetings_create_or_getCreate an onlineMeeting object with a custom specified external ID. If the external ID already exists, this API will return the onlineMeeting object with that external ID.data: {
. chatInfo
. endDateTime (string)
. externalId (string)
. participants
. startDateTime (string)
. subject (string)
} (object) required
get_communications_online_meetings_get_all_recordings_meeting_organizer_user_id_@meeting_organizer_user_id_start_date_time_@start_date_time_end_date_time_@end_date_time_Get all recordings from scheduled onlineMeeting instances for which the specified user is the organizer. This API currently doesn't support getting call recordings from channel meetings. You can apply the delta function on getAllRecordings to synchronize and get callRecording resources as they're added for onlineMeeting instances organized by the specified user. The delta query supports both full synchronization and incremental synchronization. Full synchronization gets all the recordings for onmeetingOrganizerUserId (string)
startDateTime (string)
endDateTime (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_communications_online_meetings_get_all_transcripts_meeting_organizer_user_id_@meeting_organizer_user_id_start_date_time_@start_date_time_end_date_time_@end_date_time_Get all transcripts from scheduled onlineMeeting instances for which the specified user is the organizer. This API currently doesn't support getting call transcripts from channel meetings. You can apply the delta function on getAllTranscripts to synchronize and get callTranscript resources as they're added for onlineMeeting instances organized by the specified user. Delta query supports both full synchronization and incremental synchronization. Full synchronization gets all the transcripts for omeetingOrganizerUserId (string)
startDateTime (string)
endDateTime (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_communications_presencesGet a user's presence information.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_communications_presencesCreate new navigation property to presences for communicationsdata required
get_communications_presences_by_presence_idGet a user's presence information.presence-id (string) required
$select (array)
$expand (array)
patch_communications_presences_by_presence_idUpdate the navigation property presences in communicationspresence-id (string) required
data required
delete_communications_presences_by_presence_idDelete navigation property presences for communicationspresence-id (string) required
If-Match (string)
post_communications_presences_by_presence_id_clear_presenceClear the application's presence session for a user. If it is the user's only presence session, the user's presence will change to Offline/Offline. For details about presences sessions, see presence: setPresence.presence-id (string) required
data: {
. sessionId (string)
} (object) required
post_communications_presences_by_presence_id_clear_user_preferred_presenceClear the preferred availability and activity status for a user.presence-id (string) required
post_communications_presences_by_presence_id_set_presenceSet the state of a user's presence session as an application. For more information about presence sessions, states permutations, and timeouts, see Manage presence state using the Microsoft Graph API.presence-id (string) required
data: {
. sessionId (string)
. availability (string)
. activity (string)
. expirationDuration (string)
} (object) required
post_communications_presences_by_presence_id_set_status_messageSet a presence status message for a user. An optional expiration date and time can be supplied.presence-id (string) required
data: {
. statusMessage
} (object) required
post_communications_presences_by_presence_id_set_user_preferred_presenceSet the preferred availability and activity status for a user. If the preferred presence of a user is set, the user's presence shows as the preferred status. Preferred presence takes effect only when at least one presence session exists for the user. Otherwise, the user's presence shows as Offline. A presence session is created as a result of a successful setPresence operation, or if the user is signed in on a Microsoft Teams client. For more details, see presence sessions and time-out and expirpresence-id (string) required
data: {
. availability (string)
. activity (string)
. expirationDuration (string)
} (object) required
get_communications_presences_countGet the number of the resource$search (string)
get_teamsList all teams in an organization.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamsCreate a new team.data required
get_teams_by_team_idRetrieve the properties and relationships of the specified team.team-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_idUpdate the properties of the specified team.team-id (string) required
data required
delete_teams_by_team_idDelete entity from teamsteam-id (string) required
If-Match (string)
get_teams_by_team_id_all_channelsGet the list of channels either in this team or shared with this team incoming channels.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_teams_by_team_id_all_channels_by_channel_idList of channels either hosted in or shared with the team incoming channels.team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_all_channels_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_channelsRetrieve the list of channels in this team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channelsCreate a new channel in a team, as specified in the request body. When you create a channel, the maximum length of the channel's displayName is 50 characters. This is the name that appears to the user in Microsoft Teams. If you're creating a private channel, you can add a maximum of 200 members.team-id (string) required
data required
get_teams_by_team_id_channels_by_channel_idRetrieve the properties and relationships of a channel. This method supports federation. Only a user who is a member of the shared channel can retrieve channel information.team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_idUpdate the properties of the specified channel.team-id (string) required
channel-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_idDelete the channel.team-id (string) required
channel-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_all_membersGet a list of all members in a channel. This API supports all channel types, including shared channels. For shared channels, the response includes:team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_all_membersCreate new navigation property to allMembers for teamsteam-id (string) required
channel-id (string) required
data required
get_teams_by_team_id_channels_by_channel_id_all_members_by_conversation_member_idA collection of membership records associated with the channel, including both direct and indirect members of shared channels.team-id (string) required
channel-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_all_members_by_conversation_member_idUpdate the navigation property allMembers in teamsteam-id (string) required
channel-id (string) required
conversationMember-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_all_members_by_conversation_member_idDelete navigation property allMembers for teamsteam-id (string) required
channel-id (string) required
conversationMember-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_all_members_countGet the number of the resourceteam-id (string) required
channel-id (string) required
$search (string)
post_teams_by_team_id_channels_by_channel_id_all_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
post_teams_by_team_id_channels_by_channel_id_all_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
get_teams_by_team_id_channels_by_channel_id_files_folderGet the metadata for the location where the files of a channel are stored.team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.team-id (string) required
channel-id (string) required
$format (string)
put_teams_by_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.team-id (string) required
channel-id (string) required
data (string) required
delete_teams_by_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.team-id (string) required
channel-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_membersGet a list of members in a channel, including direct members of standard, private, and shared channels. Use the List allMembers API to retrieve both direct and indirect members of a shared channel. This method supports federation. Only a user who is a member of the shared channel can retrieve the channel member list.team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_membersAdd a conversationMember to a channel. This operation is allowed only for channels with a membershipType value of private or shared.team-id (string) required
channel-id (string) required
data required
get_teams_by_team_id_channels_by_channel_id_members_by_conversation_member_idGet a conversationMember from a channel.team-id (string) required
channel-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_members_by_conversation_member_idUpdate the role of a conversationMember in a channel. This operation is allowed only for channels with a membershipType value of private or shared.team-id (string) required
channel-id (string) required
conversationMember-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_members_by_conversation_member_idDelete a conversationMember from a channel. This operation is allowed only for channels with a membershipType value of private or shared.team-id (string) required
channel-id (string) required
conversationMember-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_members_countGet the number of the resourceteam-id (string) required
channel-id (string) required
$search (string)
post_teams_by_team_id_channels_by_channel_id_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
post_teams_by_team_id_channels_by_channel_id_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
get_teams_by_team_id_channels_by_channel_id_messagesRetrieve the list of messages without the replies in a channel of a team. To get the replies for a message, call the list message replies or the get message reply API. This method supports federation. To list channel messages in application context, the request must be made from the tenant that the channel owner belongs to represented by the tenantId property on the channel.team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_messagesSend a new chatMessage in the specified channel.team-id (string) required
channel-id (string) required
data required
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_idRetrieve a single message or a message reply in a channel or a chat.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_idUpdate a chatMessage object. Except for the policyViolation property, all properties of a chatMessage can be updated in delegated permissions scenarios. Only the policyViolation property of a chatMessage can be updated in application permissions scenarios. The update only works for chats where members are Microsoft Teams users. If one of the participants is using Skype, the operation fails. This method doesn't support federation. Only the user in the tenant who sent the message can perform dateam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_idDelete navigation property messages for teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contentsRetrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contentsCreate new navigation property to hostedContents for teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data required
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idContent in a message hosted by Microsoft Teams - for example, images or code snippets.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueRetrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
put_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_countGet the number of the resourceteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$search (string)
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_set_reactionInvoke action setReactionteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_unset_reactionInvoke action unsetReactionteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_repliesList all the replies to a message in a channel of a team. This method lists only the replies of the specified message, if any. To get the message itself, call get channel message.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_repliesCreate a new reply to a chatMessage in a specified channel.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
data required
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1Retrieve a single message or a message reply in a channel or a chat.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1Update the navigation property replies in teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1Delete navigation property replies for teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsRetrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsCreate new navigation property to hostedContents for teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idContent in a message hosted by Microsoft Teams - for example, images or code snippets.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for teamsteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueRetrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
put_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_countGet the number of the resourceteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$search (string)
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_set_reactionInvoke action setReactionteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_unset_reactionInvoke action unsetReactionteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_countGet the number of the resourceteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$search (string)
get_teams_by_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLiteam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teams_by_team_id_channels_by_channel_id_messages_countGet the number of the resourceteam-id (string) required
channel-id (string) required
$search (string)
get_teams_by_team_id_channels_by_channel_id_messages_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLiteam-id (string) required
channel-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_archiveArchive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. Ateam-id (string) required
channel-id (string) required
data: {
. shouldSetSpoSiteReadOnlyForMembers (boolean)
} (object) required
post_teams_by_team_id_channels_by_channel_id_complete_migrationComplete the message migration process by removing migration mode from a channel in a team. Migration mode is a special state that prevents certain operations, like sending messages and adding members, during the data migration process. After a completeMigration request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response.team-id (string) required
channel-id (string) required
get_teams_by_team_id_channels_by_channel_id_does_user_have_access_user_id_@user_id_tenant_id_@tenant_id_user_principal_name_@user_principal_name_Determine whether a user has access to a channel.team-id (string) required
channel-id (string) required
userId (string)
tenantId (string)
userPrincipalName (string)
post_teams_by_team_id_channels_by_channel_id_provision_emailProvision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision an email address, you can call provisionEmail, or through the Teams user interface, select Get email address, which triggers Teams to generate an email address if it has not already provisioned one. To remove the email address of a channel, use the removeEmail method.team-id (string) required
channel-id (string) required
post_teams_by_team_id_channels_by_channel_id_remove_emailRemove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft Teams client.team-id (string) required
channel-id (string) required
post_teams_by_team_id_channels_by_channel_id_unarchiveRestore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive method. Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchiving operation completes successfully, which might occur after this method responds.team-id (string) required
channel-id (string) required
get_teams_by_team_id_channels_by_channel_id_shared_with_teamsGet the list of teams that has been shared a specified channel. This operation is allowed only for channels with a membershipType value of shared.team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_shared_with_teamsCreate new navigation property to sharedWithTeams for teamsteam-id (string) required
channel-id (string) required
data required
get_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idGet a team that has been shared with a specified channel. This operation is allowed only for channels with a membershipType value of shared.team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idUpdate the navigation property sharedWithTeams in teamsteam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idUnshare a channel with a team by deleting the corresponding sharedWithChannelTeamInfo resource. This operation is allowed only for channels with a membershipType value of shared.team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_membersGet the list of conversationMembers who can access a shared channel. This method does not return the following conversationMembers from the team: - Users with Guest role - Users who are externally authenticated in the tenantteam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_by_conversation_member_idA collection of team members who have access to the shared channel.team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_countGet the number of the resourceteam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$search (string)
get_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_teamGet team from teamsteam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_channels_by_channel_id_shared_with_teams_countGet the number of the resourceteam-id (string) required
channel-id (string) required
$search (string)
get_teams_by_team_id_channels_by_channel_id_tabsRetrieve the list of tabs in the specified channel within a team.team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_channels_by_channel_id_tabsAdd pin a tab to the specified channel within a team. The app must be preinstalled in the team and have the configurableTabs property defined in the app manifest.team-id (string) required
channel-id (string) required
data required
get_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_idRetrieve the properties and relationships of the specified tab in a channel within a team.team-id (string) required
channel-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_idUpdate the properties of the specified tab. This API can be used to configure the content of the tab.team-id (string) required
channel-id (string) required
teamsTab-id (string) required
data required
delete_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_idRemoves unpins a tab from the specified channel within a team.team-id (string) required
channel-id (string) required
teamsTab-id (string) required
If-Match (string)
get_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_id_teams_appThe application that is linked to the tab. This can't be changed after tab creation.team-id (string) required
channel-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_channels_by_channel_id_tabs_countGet the number of the resourceteam-id (string) required
channel-id (string) required
$search (string)
get_teams_by_team_id_channels_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_channels_get_all_messages_Retrieve messages across all channels in a team, including text, audio, and video conversations. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.team-id (string) required
model (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teams_by_team_id_channels_get_all_retained_messages_Get all retained messages across all channels in a team. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.team-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teams_by_team_id_groupGet group from teamsteam-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_group_service_provisioning_errorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter eq, not, for isResolved and serviceInstance.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_teams_by_team_id_group_service_provisioning_errors_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_incoming_channelsGet the list of incoming channels channels shared with a team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_teams_by_team_id_incoming_channels_by_channel_idList of channels shared with the team.team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_incoming_channels_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_installed_appsRetrieve a list of apps installed in the specified team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_installed_appsInstall an app to the specified team.team-id (string) required
data required
get_teams_by_team_id_installed_apps_by_teams_app_installation_idRetrieve the app installed in the specified team.team-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_installed_apps_by_teams_app_installation_idUpdate the navigation property installedApps in teamsteam-id (string) required
teamsAppInstallation-id (string) required
data required
delete_teams_by_team_id_installed_apps_by_teams_app_installation_idUninstalls an app from the specified team.team-id (string) required
teamsAppInstallation-id (string) required
If-Match (string)
post_teams_by_team_id_installed_apps_by_teams_app_installation_id_upgradeUpgrade an app installation within a chat.team-id (string) required
teamsAppInstallation-id (string) required
data: {
. consentedPermissionSet
} (object) required
get_teams_by_team_id_installed_apps_by_teams_app_installation_id_teams_appThe app that is installed.team-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_installed_apps_by_teams_app_installation_id_teams_app_definitionThe details of this version of the app.team-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_installed_apps_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_membersGet the conversationMember collection of a team. The membership IDs returned by the server must be treated as opaque strings. The client shouldn't try to parse or make assumptions about these resource IDs. In the future, membership results can include users from various tenants, as indicated in the response. Clients should avoid assuming that all members exclusively belong to the current tenant.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_membersAdd a new conversationMember to a team.team-id (string) required
data required
get_teams_by_team_id_members_by_conversation_member_idGet a conversationMember from a team.team-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_members_by_conversation_member_idUpdate the role of a conversationMember in a team.team-id (string) required
conversationMember-id (string) required
data required
delete_teams_by_team_id_members_by_conversation_member_idRemove a conversationMember from a team.team-id (string) required
conversationMember-id (string) required
If-Match (string)
get_teams_by_team_id_members_countGet the number of the resourceteam-id (string) required
$search (string)
post_teams_by_team_id_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.team-id (string) required
data: {
. values (array)
} (object) required
post_teams_by_team_id_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.team-id (string) required
data: {
. values (array)
} (object) required
post_teams_by_team_id_archiveArchive the specified team. When a team is archived, users can no longer make most changes to the team. For example, users can no longer: send or like messages on any channel in the team; edit the team's name or description; nor edit other settings. However, membership changes to the team are still allowed. Archiving is an async operation. A team is archived once the async operation completes successfully, which might occur subsequent to a response from this API. To archive a team, the team anteam-id (string) required
data: {
. shouldSetSpoSiteReadOnlyForMembers (boolean)
} (object) required
post_teams_by_team_id_cloneCreate a copy of a team. This operation also creates a copy of the corresponding group. You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation.team-id (string) required
data: {
. displayName (string)
. description (string)
. mailNickname (string)
. classification (string)
. visibility (string)
. partsToClone (string)
} (object) required
post_teams_by_team_id_complete_migrationComplete the message migration process by removing migration mode from a team. Migration mode is a special state where certain operations are barred, like message POST and membership operations during the data migration process. After a completeMigration request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response.team-id (string) required
post_teams_by_team_id_send_activity_notificationSend an activity feed notification in the scope of a team. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.team-id (string) required
data: {
. topic
. activityType (string)
. chainId (number)
. previewText
. teamsAppId (string)
. templateParameters (array)
. recipient
. iconId (string)
} (object) required
post_teams_by_team_id_unarchiveRestore an archived team. This API restores users' ability to send messages and edit the team, abiding by tenant and team settings. A Team is archived using the archive API. Unarchiving is an async operation. A team is unarchived once the async operation completes successfully, which might occur subsequent to a response from this API.team-id (string) required
get_teams_by_team_id_operationsThe async operations that ran or are running on this team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_operationsCreate new navigation property to operations for teamsteam-id (string) required
data required
get_teams_by_team_id_operations_by_teams_async_operation_idThe async operations that ran or are running on this team.team-id (string) required
teamsAsyncOperation-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_operations_by_teams_async_operation_idUpdate the navigation property operations in teamsteam-id (string) required
teamsAsyncOperation-id (string) required
data required
delete_teams_by_team_id_operations_by_teams_async_operation_idDelete navigation property operations for teamsteam-id (string) required
teamsAsyncOperation-id (string) required
If-Match (string)
get_teams_by_team_id_operations_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_permission_grantsList all resource-specific permission grants on the team. This list specifies the Microsoft Entra apps that have access to the team, along with each app's corresponding type of resource-specific access.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_permission_grantsCreate new navigation property to permissionGrants for teamsteam-id (string) required
data required
get_teams_by_team_id_permission_grants_by_resource_specific_permission_grant_idA collection of permissions granted to apps to access the team.team-id (string) required
resourceSpecificPermissionGrant-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_permission_grants_by_resource_specific_permission_grant_idUpdate the navigation property permissionGrants in teamsteam-id (string) required
resourceSpecificPermissionGrant-id (string) required
data required
delete_teams_by_team_id_permission_grants_by_resource_specific_permission_grant_idDelete navigation property permissionGrants for teamsteam-id (string) required
resourceSpecificPermissionGrant-id (string) required
If-Match (string)
get_teams_by_team_id_permission_grants_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_photoGet the specified profilePhoto or its metadata profilePhoto properties. The supported sizes of HD photos on Microsoft 365 are as follows: 48x48, 64x64, 96x96, 120x120, 240x240, 360x360, 432x432, 504x504, and 648x648. Photos can be any dimension if they're stored in Microsoft Entra ID. You can get the metadata of the largest available photo or specify a size to get the metadata for that photo size. If the size you request is unavailable, you can still get a smaller size that the user has uploadteam-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_photoUpdate the photo for the specified contact, group, team, or user in a tenant. The size of the photo you can update to is limited to 4 MB. You can use either PATCH or PUT for this operation.team-id (string) required
data required
get_teams_by_team_id_photo_valueGet the specified profilePhoto or its metadata profilePhoto properties. The supported sizes of HD photos on Microsoft 365 are as follows: 48x48, 64x64, 96x96, 120x120, 240x240, 360x360, 432x432, 504x504, and 648x648. Photos can be any dimension if they're stored in Microsoft Entra ID. You can get the metadata of the largest available photo or specify a size to get the metadata for that photo size. If the size you request is unavailable, you can still get a smaller size that the user has uploadteam-id (string) required
put_teams_by_team_id_photo_valueUpdate the photo for the specified contact, group, team, or user in a tenant. The size of the photo you can update to is limited to 4 MB. You can use either PATCH or PUT for this operation.team-id (string) required
data (string) required
delete_teams_by_team_id_photo_valueThe profile photo for the team.team-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channelGet the default channel, General, of a team.team-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channelUpdate the navigation property primaryChannel in teamsteam-id (string) required
data required
delete_teams_by_team_id_primary_channelDelete navigation property primaryChannel for teamsteam-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_all_membersA collection of membership records associated with the channel, including both direct and indirect members of shared channels.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_all_membersCreate new navigation property to allMembers for teamsteam-id (string) required
data required
get_teams_by_team_id_primary_channel_all_members_by_conversation_member_idA collection of membership records associated with the channel, including both direct and indirect members of shared channels.team-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_all_members_by_conversation_member_idUpdate the navigation property allMembers in teamsteam-id (string) required
conversationMember-id (string) required
data required
delete_teams_by_team_id_primary_channel_all_members_by_conversation_member_idDelete navigation property allMembers for teamsteam-id (string) required
conversationMember-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_all_members_countGet the number of the resourceteam-id (string) required
$search (string)
post_teams_by_team_id_primary_channel_all_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.team-id (string) required
data: {
. values (array)
} (object) required
post_teams_by_team_id_primary_channel_all_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.team-id (string) required
data: {
. values (array)
} (object) required
get_teams_by_team_id_primary_channel_files_folderMetadata for the location where the channel's files are stored.team-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_primary_channel_files_folder_contentThe content stream, if the item represents a file.team-id (string) required
$format (string)
put_teams_by_team_id_primary_channel_files_folder_contentThe content stream, if the item represents a file.team-id (string) required
data (string) required
delete_teams_by_team_id_primary_channel_files_folder_contentThe content stream, if the item represents a file.team-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_membersA collection of membership records associated with the channel.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_membersCreate new navigation property to members for teamsteam-id (string) required
data required
get_teams_by_team_id_primary_channel_members_by_conversation_member_idA collection of membership records associated with the channel.team-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_members_by_conversation_member_idUpdate the navigation property members in teamsteam-id (string) required
conversationMember-id (string) required
data required
delete_teams_by_team_id_primary_channel_members_by_conversation_member_idDelete navigation property members for teamsteam-id (string) required
conversationMember-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_members_countGet the number of the resourceteam-id (string) required
$search (string)
post_teams_by_team_id_primary_channel_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.team-id (string) required
data: {
. values (array)
} (object) required
post_teams_by_team_id_primary_channel_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.team-id (string) required
data: {
. values (array)
} (object) required
get_teams_by_team_id_primary_channel_messagesA collection of all the messages in the channel. A navigation property. Nullable.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_messagesCreate new navigation property to messages for teamsteam-id (string) required
data required
get_teams_by_team_id_primary_channel_messages_by_chat_message_idA collection of all the messages in the channel. A navigation property. Nullable.team-id (string) required
chatMessage-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_messages_by_chat_message_idUpdate the navigation property messages in teamsteam-id (string) required
chatMessage-id (string) required
data required
delete_teams_by_team_id_primary_channel_messages_by_chat_message_idDelete navigation property messages for teamsteam-id (string) required
chatMessage-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contentsContent in a message hosted by Microsoft Teams - for example, images or code snippets.team-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contentsCreate new navigation property to hostedContents for teamsteam-id (string) required
chatMessage-id (string) required
data required
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idContent in a message hosted by Microsoft Teams - for example, images or code snippets.team-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in teamsteam-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data required
delete_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for teamsteam-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
put_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_hosted_contents_countGet the number of the resourceteam-id (string) required
chatMessage-id (string) required
$search (string)
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_set_reactionInvoke action setReactionteam-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
chatMessage-id (string) required
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
chatMessage-id (string) required
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_unset_reactionInvoke action unsetReactionteam-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_repliesReplies for a specified message. Supports $expand for channel messages.team-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_repliesCreate new navigation property to replies for teamsteam-id (string) required
chatMessage-id (string) required
data required
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1Replies for a specified message. Supports $expand for channel messages.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1Update the navigation property replies in teamsteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
delete_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1Delete navigation property replies for teamsteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsContent in a message hosted by Microsoft Teams - for example, images or code snippets.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsCreate new navigation property to hostedContents for teamsteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idContent in a message hosted by Microsoft Teams - for example, images or code snippets.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in teamsteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data required
delete_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for teamsteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
put_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_countGet the number of the resourceteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$search (string)
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_set_reactionInvoke action setReactionteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.team-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_by_chat_message_id1_unset_reactionInvoke action unsetReactionteam-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_countGet the number of the resourceteam-id (string) required
chatMessage-id (string) required
$search (string)
get_teams_by_team_id_primary_channel_messages_by_chat_message_id_replies_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLiteam-id (string) required
chatMessage-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teams_by_team_id_primary_channel_messages_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_primary_channel_messages_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLiteam-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
post_teams_by_team_id_primary_channel_archiveArchive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. Ateam-id (string) required
data: {
. shouldSetSpoSiteReadOnlyForMembers (boolean)
} (object) required
post_teams_by_team_id_primary_channel_complete_migrationComplete the message migration process by removing migration mode from a channel in a team. Migration mode is a special state that prevents certain operations, like sending messages and adding members, during the data migration process. After a completeMigration request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response.team-id (string) required
get_teams_by_team_id_primary_channel_does_user_have_access_user_id_@user_id_tenant_id_@tenant_id_user_principal_name_@user_principal_name_Determine whether a user has access to a channel.team-id (string) required
userId (string)
tenantId (string)
userPrincipalName (string)
post_teams_by_team_id_primary_channel_provision_emailProvision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision an email address, you can call provisionEmail, or through the Teams user interface, select Get email address, which triggers Teams to generate an email address if it has not already provisioned one. To remove the email address of a channel, use the removeEmail method.team-id (string) required
post_teams_by_team_id_primary_channel_remove_emailRemove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft Teams client.team-id (string) required
post_teams_by_team_id_primary_channel_unarchiveRestore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive method. Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchiving operation completes successfully, which might occur after this method responds.team-id (string) required
get_teams_by_team_id_primary_channel_shared_with_teamsA collection of teams with which a channel is shared.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_shared_with_teamsCreate new navigation property to sharedWithTeams for teamsteam-id (string) required
data required
get_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_idA collection of teams with which a channel is shared.team-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_idUpdate the navigation property sharedWithTeams in teamsteam-id (string) required
sharedWithChannelTeamInfo-id (string) required
data required
delete_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_idDelete navigation property sharedWithTeams for teamsteam-id (string) required
sharedWithChannelTeamInfo-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_allowed_membersA collection of team members who have access to the shared channel.team-id (string) required
sharedWithChannelTeamInfo-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_by_conversation_member_idA collection of team members who have access to the shared channel.team-id (string) required
sharedWithChannelTeamInfo-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_countGet the number of the resourceteam-id (string) required
sharedWithChannelTeamInfo-id (string) required
$search (string)
get_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_teamGet team from teamsteam-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_primary_channel_shared_with_teams_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_primary_channel_tabsA collection of all the tabs in the channel. A navigation property.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_primary_channel_tabsCreate new navigation property to tabs for teamsteam-id (string) required
data required
get_teams_by_team_id_primary_channel_tabs_by_teams_tab_idA collection of all the tabs in the channel. A navigation property.team-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_primary_channel_tabs_by_teams_tab_idUpdate the navigation property tabs in teamsteam-id (string) required
teamsTab-id (string) required
data required
delete_teams_by_team_id_primary_channel_tabs_by_teams_tab_idDelete navigation property tabs for teamsteam-id (string) required
teamsTab-id (string) required
If-Match (string)
get_teams_by_team_id_primary_channel_tabs_by_teams_tab_id_teams_appThe application that is linked to the tab. This can't be changed after tab creation.team-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
get_teams_by_team_id_primary_channel_tabs_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_scheduleRetrieve the properties and relationships of a schedule object. The schedule creation process conforms to the One API guideline for resource based long running operations RELO. When clients use the PUT method, if the schedule is provisioned, the operation updates the schedule; otherwise, the operation starts the schedule provisioning process in the background. During schedule provisioning, clients can use the GET method to get the schedule and look at the provisionStatus property for the currenteam-id (string) required
$select (array)
$expand (array)
put_teams_by_team_id_scheduleCreate or replace a schedule object. The schedule creation process conforms to the One API guideline for resource based long running operations RELO. When clients use the PUT method, if the schedule is provisioned, the operation replaces the schedule; otherwise, the operation starts the schedule provisioning process in the background. During schedule provisioning, clients can use the GET method to get the schedule and look at the provisionStatus property for the current state of the provisioninteam-id (string) required
data required
delete_teams_by_team_id_scheduleDelete navigation property schedule for teamsteam-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_day_notesThe day notes in the schedule.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_day_notesCreate new navigation property to dayNotes for teamsteam-id (string) required
data required
get_teams_by_team_id_schedule_day_notes_by_day_note_idThe day notes in the schedule.team-id (string) required
dayNote-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_day_notes_by_day_note_idUpdate the navigation property dayNotes in teamsteam-id (string) required
dayNote-id (string) required
data required
delete_teams_by_team_id_schedule_day_notes_by_day_note_idDelete navigation property dayNotes for teamsteam-id (string) required
dayNote-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_day_notes_countGet the number of the resourceteam-id (string) required
$search (string)
post_teams_by_team_id_schedule_shareShare a schedule time range with schedule members. This action makes the collections of shift, openshift and timeOff items in the specified time range of the schedule viewable by the specified team members, including employees and managers. Each shift, openshift and timeOff instance in a schedule supports a draft version and a shared version of the item. The draft version is viewable by only managers, and the shared version is viewable by employees and managers. For each shift, openshift and timteam-id (string) required
data: {
. notifyTeam (boolean)
. startDateTime (string)
. endDateTime (string)
} (object) required
get_teams_by_team_id_schedule_offer_shift_requestsRetrieve the properties and relationships of all offerShiftRequest objects in a team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_offer_shift_requestsCreate an instance of an offerShiftRequest.team-id (string) required
data required
get_teams_by_team_id_schedule_offer_shift_requests_by_offer_shift_request_idRetrieve the properties and relationships of an offerShiftRequest object.team-id (string) required
offerShiftRequest-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_offer_shift_requests_by_offer_shift_request_idUpdate the navigation property offerShiftRequests in teamsteam-id (string) required
offerShiftRequest-id (string) required
data required
delete_teams_by_team_id_schedule_offer_shift_requests_by_offer_shift_request_idDelete navigation property offerShiftRequests for teamsteam-id (string) required
offerShiftRequest-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_offer_shift_requests_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_open_shift_change_requestsRetrieve a list of openShiftChangeRequest objects in a team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_open_shift_change_requestsCreate instance of an openShiftChangeRequest object.team-id (string) required
data required
get_teams_by_team_id_schedule_open_shift_change_requests_by_open_shift_change_request_idRetrieve the properties and relationships of an openShiftChangeRequest object.team-id (string) required
openShiftChangeRequest-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_open_shift_change_requests_by_open_shift_change_request_idUpdate the navigation property openShiftChangeRequests in teamsteam-id (string) required
openShiftChangeRequest-id (string) required
data required
delete_teams_by_team_id_schedule_open_shift_change_requests_by_open_shift_change_request_idDelete navigation property openShiftChangeRequests for teamsteam-id (string) required
openShiftChangeRequest-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_open_shift_change_requests_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_open_shiftsList openShift objects in a team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_open_shiftsCreate an instance of an openShift object.team-id (string) required
data required
get_teams_by_team_id_schedule_open_shifts_by_open_shift_idRetrieve the properties and relationships of an openshift object.team-id (string) required
openShift-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_open_shifts_by_open_shift_idUpdate the properties of an openShift object.team-id (string) required
openShift-id (string) required
data required
delete_teams_by_team_id_schedule_open_shifts_by_open_shift_idDelete an openShift object.team-id (string) required
openShift-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_open_shifts_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_scheduling_groupsGet the list of schedulingGroups in this schedule.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_scheduling_groupsCreate a new schedulingGroup.team-id (string) required
data required
get_teams_by_team_id_schedule_scheduling_groups_by_scheduling_group_idRetrieve the properties and relationships of a schedulingGroup by ID.team-id (string) required
schedulingGroup-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_scheduling_groups_by_scheduling_group_idReplace an existing schedulingGroup. If the specified schedulingGroup doesn't exist, this method returns 404 Not found.team-id (string) required
schedulingGroup-id (string) required
data required
delete_teams_by_team_id_schedule_scheduling_groups_by_scheduling_group_idMark a schedulingGroup as inactive by setting its isActive property. This method does not remove the schedulingGroup from the schedule. Existing shift instances assigned to the scheduling group remain part of the group.team-id (string) required
schedulingGroup-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_scheduling_groups_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_shiftsGet the list of shift instances in a schedule.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_shiftsCreate a new shift instance in a schedule. The duration of a shift cannot be less than 1 minute or longer than 24 hours.team-id (string) required
data required
get_teams_by_team_id_schedule_shifts_by_shift_idRetrieve the properties and relationships of a shift object by ID.team-id (string) required
shift-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_shifts_by_shift_idReplace an existing shift. If the specified shift doesn't exist, this method returns 404 Not found. The duration of a shift can't be less than one minute or longer than 24 hours.team-id (string) required
shift-id (string) required
data required
delete_teams_by_team_id_schedule_shifts_by_shift_idDelete a shift from the schedule.team-id (string) required
shift-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_shifts_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_swap_shifts_change_requestsRetrieve a list of swapShiftsChangeRequest objects in the team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_swap_shifts_change_requestsCreate an instance of a swapShiftsChangeRequest object.team-id (string) required
data required
get_teams_by_team_id_schedule_swap_shifts_change_requests_by_swap_shifts_change_request_idRetrieve the properties and relationships of a swapShiftsChangeRequest object.team-id (string) required
swapShiftsChangeRequest-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_swap_shifts_change_requests_by_swap_shifts_change_request_idUpdate the navigation property swapShiftsChangeRequests in teamsteam-id (string) required
swapShiftsChangeRequest-id (string) required
data required
delete_teams_by_team_id_schedule_swap_shifts_change_requests_by_swap_shifts_change_request_idDelete navigation property swapShiftsChangeRequests for teamsteam-id (string) required
swapShiftsChangeRequest-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_swap_shifts_change_requests_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_time_cardsRetrieve a list of timeCard entries in a schedule.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_time_cardsCreate a timeCard instance in a schedule.team-id (string) required
data required
get_teams_by_team_id_schedule_time_cards_by_time_card_idThe time cards in the schedule.team-id (string) required
timeCard-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_time_cards_by_time_card_idUpdate the navigation property timeCards in teamsteam-id (string) required
timeCard-id (string) required
data required
delete_teams_by_team_id_schedule_time_cards_by_time_card_idDelete a timeCard instance in a schedule.team-id (string) required
timeCard-id (string) required
If-Match (string)
post_teams_by_team_id_schedule_time_cards_by_time_card_id_clock_outInvoke action clockOutteam-id (string) required
timeCard-id (string) required
data: {
. isAtApprovedLocation (boolean)
. notes
} (object) required
post_teams_by_team_id_schedule_time_cards_by_time_card_id_confirmConfirm a timeCard.team-id (string) required
timeCard-id (string) required
post_teams_by_team_id_schedule_time_cards_by_time_card_id_end_breakInvoke action endBreakteam-id (string) required
timeCard-id (string) required
data: {
. isAtApprovedLocation (boolean)
. notes
} (object) required
post_teams_by_team_id_schedule_time_cards_by_time_card_id_start_breakInvoke action startBreakteam-id (string) required
timeCard-id (string) required
data: {
. isAtApprovedLocation (boolean)
. notes
} (object) required
get_teams_by_team_id_schedule_time_cards_countGet the number of the resourceteam-id (string) required
$search (string)
post_teams_by_team_id_schedule_time_cards_clock_inClock in to start a timeCard.team-id (string) required
data: {
. isAtApprovedLocation (boolean)
. onBehalfOfUserId (string)
. notes
} (object) required
get_teams_by_team_id_schedule_time_off_reasonsGet the list of timeOffReasons in a schedule.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_time_off_reasonsCreate a new timeOffReason.team-id (string) required
data required
get_teams_by_team_id_schedule_time_off_reasons_by_time_off_reason_idRetrieve the properties and relationships of a timeOffReason object by ID.team-id (string) required
timeOffReason-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_time_off_reasons_by_time_off_reason_idReplace an existing timeOffReason. If the specified timeOffReason doesn't exist, this method returns 404 Not found.team-id (string) required
timeOffReason-id (string) required
data required
delete_teams_by_team_id_schedule_time_off_reasons_by_time_off_reason_idMark a timeOffReason as inactive by setting the isActive property. Every team must include at least one timeoff reason. This method doesn't remove the specified timeOffReason instance. timeOffItem instances that have been assigned this reason remain assigned to this reason.team-id (string) required
timeOffReason-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_time_off_reasons_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_time_off_requestsRetrieve a list of timeOffRequest objects in the team.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_time_off_requestsCreate instance of a timeoffrequest object.team-id (string) required
data required
get_teams_by_team_id_schedule_time_off_requests_by_time_off_request_idRetrieve the properties and relationships of a timeoffrequest object.team-id (string) required
timeOffRequest-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_time_off_requests_by_time_off_request_idUpdate the navigation property timeOffRequests in teamsteam-id (string) required
timeOffRequest-id (string) required
data required
delete_teams_by_team_id_schedule_time_off_requests_by_time_off_request_idDelete a timeOffRequest object.team-id (string) required
timeOffRequest-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_time_off_requests_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_schedule_times_offGet the list of timeOff instances in a schedule.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_schedule_times_offCreate a new timeOff instance in a schedule.team-id (string) required
data required
get_teams_by_team_id_schedule_times_off_by_time_off_idRetrieve the properties and relationships of a timeOff object by ID.team-id (string) required
timeOff-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_schedule_times_off_by_time_off_idReplace an existing timeOff object. If the specified timeOff object doesn't exist, this method returns 404 Not found.team-id (string) required
timeOff-id (string) required
data required
delete_teams_by_team_id_schedule_times_off_by_time_off_idDelete a timeOff instance from a schedule.team-id (string) required
timeOff-id (string) required
If-Match (string)
get_teams_by_team_id_schedule_times_off_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_tagsGet a list of the tag objects and their properties.team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_tagsCreate a standard tag for members in a team.team-id (string) required
data required
get_teams_by_team_id_tags_by_teamwork_tag_idRead the properties and relationships of a tag object.team-id (string) required
teamworkTag-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_tags_by_teamwork_tag_idUpdate the properties of a tag object.team-id (string) required
teamworkTag-id (string) required
data required
delete_teams_by_team_id_tags_by_teamwork_tag_idDelete a tag object permanently.team-id (string) required
teamworkTag-id (string) required
If-Match (string)
get_teams_by_team_id_tags_by_teamwork_tag_id_membersGet a list of the members of a standard tag in a team and their properties.team-id (string) required
teamworkTag-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_by_team_id_tags_by_teamwork_tag_id_membersCreate a new teamworkTagMember object in a team.team-id (string) required
teamworkTag-id (string) required
data required
get_teams_by_team_id_tags_by_teamwork_tag_id_members_by_teamwork_tag_member_idGet the properties and relationships of a member of a standard tag in a team.team-id (string) required
teamworkTag-id (string) required
teamworkTagMember-id (string) required
$select (array)
$expand (array)
patch_teams_by_team_id_tags_by_teamwork_tag_id_members_by_teamwork_tag_member_idUpdate the navigation property members in teamsteam-id (string) required
teamworkTag-id (string) required
teamworkTagMember-id (string) required
data required
delete_teams_by_team_id_tags_by_teamwork_tag_id_members_by_teamwork_tag_member_idDelete a member from a standard tag in a team.team-id (string) required
teamworkTag-id (string) required
teamworkTagMember-id (string) required
If-Match (string)
get_teams_by_team_id_tags_by_teamwork_tag_id_members_countGet the number of the resourceteam-id (string) required
teamworkTag-id (string) required
$search (string)
get_teams_by_team_id_tags_countGet the number of the resourceteam-id (string) required
$search (string)
get_teams_by_team_id_templateThe template this team was created from. See available templates.team-id (string) required
$select (array)
$expand (array)
get_teams_countGet the number of the resource$search (string)
get_teams_get_all_messages_Invoke function getAllMessagesmodel (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teams_templatesGet entities from teamsTemplates$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teams_templatesAdd new entity to teamsTemplatesdata required
get_teams_templates_by_teams_template_idGet entity from teamsTemplates by keyteamsTemplate-id (string) required
$select (array)
$expand (array)
patch_teams_templates_by_teams_template_idUpdate entity in teamsTemplatesteamsTemplate-id (string) required
data required
delete_teams_templates_by_teams_template_idDelete entity from teamsTemplatesteamsTemplate-id (string) required
If-Match (string)
get_teams_templates_countGet the number of the resource$search (string)
get_teamworkGet the properties and relationships of a teamwork object, such as the region of the organization and whether Microsoft Teams is enabled.$select (array)
$expand (array)
patch_teamworkUpdate teamworkdata required
get_teamwork_deleted_chatsRead the properties and relationships of a deletedChat object.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_chatsCreate new navigation property to deletedChats for teamworkdata required
get_teamwork_deleted_chats_by_deleted_chat_idRead the properties and relationships of a deletedChat object.deletedChat-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_chats_by_deleted_chat_idUpdate the navigation property deletedChats in teamworkdeletedChat-id (string) required
data required
delete_teamwork_deleted_chats_by_deleted_chat_idDelete navigation property deletedChats for teamworkdeletedChat-id (string) required
If-Match (string)
post_teamwork_deleted_chats_by_deleted_chat_id_undo_deleteRestore a deletedChat to an active chat.deletedChat-id (string) required
get_teamwork_deleted_chats_countGet the number of the resource$search (string)
get_teamwork_deleted_teamsGet a list of the deletedTeam objects and their properties.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teamsCreate new navigation property to deletedTeams for teamworkdata required
get_teamwork_deleted_teams_by_deleted_team_idThe deleted team.deletedTeam-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_idUpdate the navigation property deletedTeams in teamworkdeletedTeam-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_idDelete navigation property deletedTeams for teamworkdeletedTeam-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channelsThe channels that are either shared with this deleted team or created in this deleted team.deletedTeam-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channelsCreate new navigation property to channels for teamworkdeletedTeam-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_idThe channels that are either shared with this deleted team or created in this deleted team.deletedTeam-id (string) required
channel-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_idUpdate the navigation property channels in teamworkdeletedTeam-id (string) required
channel-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_idDelete navigation property channels for teamworkdeletedTeam-id (string) required
channel-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_membersA collection of membership records associated with the channel, including both direct and indirect members of shared channels.deletedTeam-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_membersCreate new navigation property to allMembers for teamworkdeletedTeam-id (string) required
channel-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_members_by_conversation_member_idA collection of membership records associated with the channel, including both direct and indirect members of shared channels.deletedTeam-id (string) required
channel-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_members_by_conversation_member_idUpdate the navigation property allMembers in teamworkdeletedTeam-id (string) required
channel-id (string) required
conversationMember-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_members_by_conversation_member_idDelete navigation property allMembers for teamworkdeletedTeam-id (string) required
channel-id (string) required
conversationMember-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_members_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
$search (string)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.deletedTeam-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_all_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.deletedTeam-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_files_folderMetadata for the location where the channel's files are stored.deletedTeam-id (string) required
channel-id (string) required
$select (array)
$expand (array)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.deletedTeam-id (string) required
channel-id (string) required
$format (string)
put_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.deletedTeam-id (string) required
channel-id (string) required
data (string) required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.deletedTeam-id (string) required
channel-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_membersA collection of membership records associated with the channel.deletedTeam-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_membersCreate new navigation property to members for teamworkdeletedTeam-id (string) required
channel-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_members_by_conversation_member_idA collection of membership records associated with the channel.deletedTeam-id (string) required
channel-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_members_by_conversation_member_idUpdate the navigation property members in teamworkdeletedTeam-id (string) required
channel-id (string) required
conversationMember-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_members_by_conversation_member_idDelete navigation property members for teamworkdeletedTeam-id (string) required
channel-id (string) required
conversationMember-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_members_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
$search (string)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.deletedTeam-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.deletedTeam-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messagesA collection of all the messages in the channel. A navigation property. Nullable.deletedTeam-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messagesCreate new navigation property to messages for teamworkdeletedTeam-id (string) required
channel-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_idA collection of all the messages in the channel. A navigation property. Nullable.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_idUpdate the navigation property messages in teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_idDelete navigation property messages for teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contentsContent in a message hosted by Microsoft Teams - for example, images or code snippets.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contentsCreate new navigation property to hostedContents for teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idContent in a message hosted by Microsoft Teams - for example, images or code snippets.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
put_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_hosted_contents_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$search (string)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_set_reactionInvoke action setReactiondeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_unset_reactionInvoke action unsetReactiondeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data: {
. reactionType (string)
} (object) required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_repliesReplies for a specified message. Supports $expand for channel messages.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_repliesCreate new navigation property to replies for teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1Replies for a specified message. Supports $expand for channel messages.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1Update the navigation property replies in teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1Delete navigation property replies for teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsContent in a message hosted by Microsoft Teams - for example, images or code snippets.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contentsCreate new navigation property to hostedContents for teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idContent in a message hosted by Microsoft Teams - for example, images or code snippets.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idUpdate the navigation property hostedContents in teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_idDelete navigation property hostedContents for teamworkdeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
put_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
data (string) required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_by_chat_message_hosted_content_id_valueThe unique identifier for an entity. Read-only.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
chatMessageHostedContent-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_hosted_contents_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
$search (string)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_set_reactionInvoke action setReactiondeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_soft_deleteDelete a single chatMessage or a chat message reply in a channel or a chat.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_undo_soft_deleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.deletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_by_chat_message_id1_unset_reactionInvoke action unsetReactiondeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
chatMessage-id1 (string) required
data: {
. reactionType (string)
} (object) required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$search (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_by_chat_message_id_replies_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLideletedTeam-id (string) required
channel-id (string) required
chatMessage-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
$search (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_messages_delta_Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLideletedTeam-id (string) required
channel-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_archiveArchive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. AdeletedTeam-id (string) required
channel-id (string) required
data: {
. shouldSetSpoSiteReadOnlyForMembers (boolean)
} (object) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_complete_migrationComplete the message migration process by removing migration mode from a channel in a team. Migration mode is a special state that prevents certain operations, like sending messages and adding members, during the data migration process. After a completeMigration request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response.deletedTeam-id (string) required
channel-id (string) required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_does_user_have_access_user_id_@user_id_tenant_id_@tenant_id_user_principal_name_@user_principal_name_Determine whether a user has access to a channel.deletedTeam-id (string) required
channel-id (string) required
userId (string)
tenantId (string)
userPrincipalName (string)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_provision_emailProvision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision an email address, you can call provisionEmail, or through the Teams user interface, select Get email address, which triggers Teams to generate an email address if it has not already provisioned one. To remove the email address of a channel, use the removeEmail method.deletedTeam-id (string) required
channel-id (string) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_remove_emailRemove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft Teams client.deletedTeam-id (string) required
channel-id (string) required
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_unarchiveRestore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive method. Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchiving operation completes successfully, which might occur after this method responds.deletedTeam-id (string) required
channel-id (string) required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teamsA collection of teams with which a channel is shared.deletedTeam-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teamsCreate new navigation property to sharedWithTeams for teamworkdeletedTeam-id (string) required
channel-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idA collection of teams with which a channel is shared.deletedTeam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idUpdate the navigation property sharedWithTeams in teamworkdeletedTeam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idDelete navigation property sharedWithTeams for teamworkdeletedTeam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_membersA collection of team members who have access to the shared channel.deletedTeam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_by_conversation_member_idA collection of team members who have access to the shared channel.deletedTeam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$search (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_teamGet team from teamworkdeletedTeam-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_shared_with_teams_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
$search (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_tabsA collection of all the tabs in the channel. A navigation property.deletedTeam-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_tabsCreate new navigation property to tabs for teamworkdeletedTeam-id (string) required
channel-id (string) required
data required
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_tabs_by_teams_tab_idA collection of all the tabs in the channel. A navigation property.deletedTeam-id (string) required
channel-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
patch_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_tabs_by_teams_tab_idUpdate the navigation property tabs in teamworkdeletedTeam-id (string) required
channel-id (string) required
teamsTab-id (string) required
data required
delete_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_tabs_by_teams_tab_idDelete navigation property tabs for teamworkdeletedTeam-id (string) required
channel-id (string) required
teamsTab-id (string) required
If-Match (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_tabs_by_teams_tab_id_teams_appThe application that is linked to the tab. This can't be changed after tab creation.deletedTeam-id (string) required
channel-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
get_teamwork_deleted_teams_by_deleted_team_id_channels_by_channel_id_tabs_countGet the number of the resourcedeletedTeam-id (string) required
channel-id (string) required
$search (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_countGet the number of the resourcedeletedTeam-id (string) required
$search (string)
get_teamwork_deleted_teams_by_deleted_team_id_channels_get_all_messages_Retrieve messages across all channels in a team, including text, audio, and video conversations. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.deletedTeam-id (string) required
model (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teamwork_deleted_teams_by_deleted_team_id_channels_get_all_retained_messages_Get all retained messages across all channels in a team. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.deletedTeam-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_teamwork_deleted_teams_countGet the number of the resource$search (string)
get_teamwork_deleted_teams_get_all_messages_Invoke function getAllMessagesmodel (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
post_teamwork_send_activity_notification_to_recipientsSend activity feed notifications to multiple users, in bulk. For more information, see sending Teams activity notifications.data: {
. topic
. activityType (string)
. chainId (number)
. previewText
. teamsAppId (string)
. templateParameters (array)
. recipients (array)
. iconId (string)
} (object) required
get_teamwork_teams_app_settingsGet the tenant-wide teamsAppSettings for all Teams apps in the tenant.$select (array)
$expand (array)
patch_teamwork_teams_app_settingsUpdate the tenant-wide teamsAppSettings for all Teams apps in the tenant.data required
delete_teamwork_teams_app_settingsDelete navigation property teamsAppSettings for teamworkIf-Match (string)
get_teamwork_workforce_integrationsRetrieve a list of workforceIntegration objects.$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_teamwork_workforce_integrationsCreate a new workforceIntegration object.data required
get_teamwork_workforce_integrations_by_workforce_integration_idRetrieve the properties and relationships of a workforceIntegration object.workforceIntegration-id (string) required
$select (array)
$expand (array)
patch_teamwork_workforce_integrations_by_workforce_integration_idUpdate the properties of a workforceIntegration object.workforceIntegration-id (string) required
data required
delete_teamwork_workforce_integrations_by_workforce_integration_idDelete an instance of a workforceIntegration.workforceIntegration-id (string) required
If-Match (string)
get_teamwork_workforce_integrations_countGet the number of the resource$search (string)
get_users_by_user_id_joined_teamsGet joinedTeams from usersuser-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teamsCreate new navigation property to joinedTeams for usersuser-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_idGet joinedTeams from usersuser-id (string) required
team-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_idUpdate the navigation property joinedTeams in usersuser-id (string) required
team-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_idDelete navigation property joinedTeams for usersuser-id (string) required
team-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_all_channelsList of channels either hosted in or shared with the team incoming channels.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_all_channels_by_channel_idList of channels either hosted in or shared with the team incoming channels.user-id (string) required
team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_all_channels_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_channelsThe collection of channels and messages associated with the team.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_channelsCreate new navigation property to channels for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_idThe collection of channels and messages associated with the team.user-id (string) required
team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_channels_by_channel_idUpdate the navigation property channels in usersuser-id (string) required
team-id (string) required
channel-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_channels_by_channel_idDelete navigation property channels for usersuser-id (string) required
team-id (string) required
channel-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_membersA collection of membership records associated with the channel, including both direct and indirect members of shared channels.user-id (string) required
team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_membersCreate new navigation property to allMembers for usersuser-id (string) required
team-id (string) required
channel-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_members_by_conversation_member_idA collection of membership records associated with the channel, including both direct and indirect members of shared channels.user-id (string) required
team-id (string) required
channel-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_members_by_conversation_member_idUpdate the navigation property allMembers in usersuser-id (string) required
team-id (string) required
channel-id (string) required
conversationMember-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_members_by_conversation_member_idDelete navigation property allMembers for usersuser-id (string) required
team-id (string) required
channel-id (string) required
conversationMember-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
channel-id (string) required
$search (string)
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.user-id (string) required
team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_all_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.user-id (string) required
team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_files_folderMetadata for the location where the channel's files are stored.user-id (string) required
team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.user-id (string) required
team-id (string) required
channel-id (string) required
$format (string)
put_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.user-id (string) required
team-id (string) required
channel-id (string) required
data (string) required
delete_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_files_folder_contentThe content stream, if the item represents a file.user-id (string) required
team-id (string) required
channel-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_membersA collection of membership records associated with the channel.user-id (string) required
team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_membersCreate new navigation property to members for usersuser-id (string) required
team-id (string) required
channel-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_members_by_conversation_member_idA collection of membership records associated with the channel.user-id (string) required
team-id (string) required
channel-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_members_by_conversation_member_idUpdate the navigation property members in usersuser-id (string) required
team-id (string) required
channel-id (string) required
conversationMember-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_members_by_conversation_member_idDelete navigation property members for usersuser-id (string) required
team-id (string) required
channel-id (string) required
conversationMember-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
channel-id (string) required
$search (string)
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.user-id (string) required
team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.user-id (string) required
team-id (string) required
channel-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_archiveArchive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. Auser-id (string) required
team-id (string) required
channel-id (string) required
data: {
. shouldSetSpoSiteReadOnlyForMembers (boolean)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_complete_migrationComplete the message migration process by removing migration mode from a channel in a team. Migration mode is a special state that prevents certain operations, like sending messages and adding members, during the data migration process. After a completeMigration request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response.user-id (string) required
team-id (string) required
channel-id (string) required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_does_user_have_access_user_id_@user_id_tenant_id_@tenant_id_user_principal_name_@user_principal_name_Determine whether a user has access to a channel.user-id (string) required
team-id (string) required
channel-id (string) required
userId (string)
tenantId (string)
userPrincipalName (string)
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_provision_emailProvision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision an email address, you can call provisionEmail, or through the Teams user interface, select Get email address, which triggers Teams to generate an email address if it has not already provisioned one. To remove the email address of a channel, use the removeEmail method.user-id (string) required
team-id (string) required
channel-id (string) required
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_remove_emailRemove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft Teams client.user-id (string) required
team-id (string) required
channel-id (string) required
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_unarchiveRestore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive method. Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchiving operation completes successfully, which might occur after this method responds.user-id (string) required
team-id (string) required
channel-id (string) required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teamsA collection of teams with which a channel is shared.user-id (string) required
team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teamsCreate new navigation property to sharedWithTeams for usersuser-id (string) required
team-id (string) required
channel-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idA collection of teams with which a channel is shared.user-id (string) required
team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idUpdate the navigation property sharedWithTeams in usersuser-id (string) required
team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_idDelete navigation property sharedWithTeams for usersuser-id (string) required
team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_membersA collection of team members who have access to the shared channel.user-id (string) required
team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_by_conversation_member_idA collection of team members who have access to the shared channel.user-id (string) required
team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_by_shared_with_channel_team_info_id_teamGet team from usersuser-id (string) required
team-id (string) required
channel-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_shared_with_teams_countGet the number of the resourceuser-id (string) required
team-id (string) required
channel-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_tabsA collection of all the tabs in the channel. A navigation property.user-id (string) required
team-id (string) required
channel-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_tabsCreate new navigation property to tabs for usersuser-id (string) required
team-id (string) required
channel-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_idA collection of all the tabs in the channel. A navigation property.user-id (string) required
team-id (string) required
channel-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_idUpdate the navigation property tabs in usersuser-id (string) required
team-id (string) required
channel-id (string) required
teamsTab-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_idDelete navigation property tabs for usersuser-id (string) required
team-id (string) required
channel-id (string) required
teamsTab-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_tabs_by_teams_tab_id_teams_appThe application that is linked to the tab. This can't be changed after tab creation.user-id (string) required
team-id (string) required
channel-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_channels_by_channel_id_tabs_countGet the number of the resourceuser-id (string) required
team-id (string) required
channel-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_channels_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_channels_get_all_messages_Retrieve messages across all channels in a team, including text, audio, and video conversations. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.user-id (string) required
team-id (string) required
model (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_channels_get_all_retained_messages_Get all retained messages across all channels in a team. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content with the Microsoft Teams export APIs.user-id (string) required
team-id (string) required
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_groupGet group from usersuser-id (string) required
team-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_group_service_provisioning_errorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter eq, not, for isResolved and serviceInstance.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_group_service_provisioning_errors_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_incoming_channelsList of channels shared with the team.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_incoming_channels_by_channel_idList of channels shared with the team.user-id (string) required
team-id (string) required
channel-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_incoming_channels_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_installed_appsThe apps installed in this team.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_installed_appsCreate new navigation property to installedApps for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_installed_apps_by_teams_app_installation_idThe apps installed in this team.user-id (string) required
team-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_installed_apps_by_teams_app_installation_idUpdate the navigation property installedApps in usersuser-id (string) required
team-id (string) required
teamsAppInstallation-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_installed_apps_by_teams_app_installation_idDelete navigation property installedApps for usersuser-id (string) required
team-id (string) required
teamsAppInstallation-id (string) required
If-Match (string)
post_users_by_user_id_joined_teams_by_team_id_installed_apps_by_teams_app_installation_id_upgradeUpgrade an app installation within a chat.user-id (string) required
team-id (string) required
teamsAppInstallation-id (string) required
data: {
. consentedPermissionSet
} (object) required
get_users_by_user_id_joined_teams_by_team_id_installed_apps_by_teams_app_installation_id_teams_appThe app that is installed.user-id (string) required
team-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_installed_apps_by_teams_app_installation_id_teams_app_definitionThe details of this version of the app.user-id (string) required
team-id (string) required
teamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_installed_apps_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_membersMembers and owners of the team.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_membersCreate new navigation property to members for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_members_by_conversation_member_idMembers and owners of the team.user-id (string) required
team-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_members_by_conversation_member_idUpdate the navigation property members in usersuser-id (string) required
team-id (string) required
conversationMember-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_members_by_conversation_member_idDelete navigation property members for usersuser-id (string) required
team-id (string) required
conversationMember-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
post_users_by_user_id_joined_teams_by_team_id_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.user-id (string) required
team-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.user-id (string) required
team-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_archiveArchive the specified team. When a team is archived, users can no longer make most changes to the team. For example, users can no longer: send or like messages on any channel in the team; edit the team's name or description; nor edit other settings. However, membership changes to the team are still allowed. Archiving is an async operation. A team is archived once the async operation completes successfully, which might occur subsequent to a response from this API. To archive a team, the team anuser-id (string) required
team-id (string) required
data: {
. shouldSetSpoSiteReadOnlyForMembers (boolean)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_cloneCreate a copy of a team. This operation also creates a copy of the corresponding group. You can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation.user-id (string) required
team-id (string) required
data: {
. displayName (string)
. description (string)
. mailNickname (string)
. classification (string)
. visibility (string)
. partsToClone (string)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_complete_migrationComplete the message migration process by removing migration mode from a team. Migration mode is a special state where certain operations are barred, like message POST and membership operations during the data migration process. After a completeMigration request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response.user-id (string) required
team-id (string) required
post_users_by_user_id_joined_teams_by_team_id_send_activity_notificationSend an activity feed notification in the scope of a team. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.user-id (string) required
team-id (string) required
data: {
. topic
. activityType (string)
. chainId (number)
. previewText
. teamsAppId (string)
. templateParameters (array)
. recipient
. iconId (string)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_unarchiveRestore an archived team. This API restores users' ability to send messages and edit the team, abiding by tenant and team settings. A Team is archived using the archive API. Unarchiving is an async operation. A team is unarchived once the async operation completes successfully, which might occur subsequent to a response from this API.user-id (string) required
team-id (string) required
get_users_by_user_id_joined_teams_by_team_id_operationsThe async operations that ran or are running on this team.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_operationsCreate new navigation property to operations for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_operations_by_teams_async_operation_idThe async operations that ran or are running on this team.user-id (string) required
team-id (string) required
teamsAsyncOperation-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_operations_by_teams_async_operation_idUpdate the navigation property operations in usersuser-id (string) required
team-id (string) required
teamsAsyncOperation-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_operations_by_teams_async_operation_idDelete navigation property operations for usersuser-id (string) required
team-id (string) required
teamsAsyncOperation-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_operations_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_permission_grantsA collection of permissions granted to apps to access the team.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_permission_grantsCreate new navigation property to permissionGrants for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_permission_grants_by_resource_specific_permission_grant_idA collection of permissions granted to apps to access the team.user-id (string) required
team-id (string) required
resourceSpecificPermissionGrant-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_permission_grants_by_resource_specific_permission_grant_idUpdate the navigation property permissionGrants in usersuser-id (string) required
team-id (string) required
resourceSpecificPermissionGrant-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_permission_grants_by_resource_specific_permission_grant_idDelete navigation property permissionGrants for usersuser-id (string) required
team-id (string) required
resourceSpecificPermissionGrant-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_permission_grants_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_photoThe profile photo for the team.user-id (string) required
team-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_photoUpdate the navigation property photo in usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_photo_valueThe profile photo for the team.user-id (string) required
team-id (string) required
put_users_by_user_id_joined_teams_by_team_id_photo_valueThe profile photo for the team.user-id (string) required
team-id (string) required
data (string) required
delete_users_by_user_id_joined_teams_by_team_id_photo_valueThe profile photo for the team.user-id (string) required
team-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channelThe general channel for the team.user-id (string) required
team-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_primary_channelUpdate the navigation property primaryChannel in usersuser-id (string) required
team-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_primary_channelDelete navigation property primaryChannel for usersuser-id (string) required
team-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_all_membersA collection of membership records associated with the channel, including both direct and indirect members of shared channels.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_primary_channel_all_membersCreate new navigation property to allMembers for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_primary_channel_all_members_by_conversation_member_idA collection of membership records associated with the channel, including both direct and indirect members of shared channels.user-id (string) required
team-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_primary_channel_all_members_by_conversation_member_idUpdate the navigation property allMembers in usersuser-id (string) required
team-id (string) required
conversationMember-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_primary_channel_all_members_by_conversation_member_idDelete navigation property allMembers for usersuser-id (string) required
team-id (string) required
conversationMember-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_all_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
post_users_by_user_id_joined_teams_by_team_id_primary_channel_all_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.user-id (string) required
team-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_primary_channel_all_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.user-id (string) required
team-id (string) required
data: {
. values (array)
} (object) required
get_users_by_user_id_joined_teams_by_team_id_primary_channel_files_folderMetadata for the location where the channel's files are stored.user-id (string) required
team-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_files_folder_contentThe content stream, if the item represents a file.user-id (string) required
team-id (string) required
$format (string)
put_users_by_user_id_joined_teams_by_team_id_primary_channel_files_folder_contentThe content stream, if the item represents a file.user-id (string) required
team-id (string) required
data (string) required
delete_users_by_user_id_joined_teams_by_team_id_primary_channel_files_folder_contentThe content stream, if the item represents a file.user-id (string) required
team-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_membersA collection of membership records associated with the channel.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_primary_channel_membersCreate new navigation property to members for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_primary_channel_members_by_conversation_member_idA collection of membership records associated with the channel.user-id (string) required
team-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_primary_channel_members_by_conversation_member_idUpdate the navigation property members in usersuser-id (string) required
team-id (string) required
conversationMember-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_primary_channel_members_by_conversation_member_idDelete navigation property members for usersuser-id (string) required
team-id (string) required
conversationMember-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
post_users_by_user_id_joined_teams_by_team_id_primary_channel_members_addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.user-id (string) required
team-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_primary_channel_members_removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.user-id (string) required
team-id (string) required
data: {
. values (array)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_primary_channel_archiveArchive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. Auser-id (string) required
team-id (string) required
data: {
. shouldSetSpoSiteReadOnlyForMembers (boolean)
} (object) required
post_users_by_user_id_joined_teams_by_team_id_primary_channel_complete_migrationComplete the message migration process by removing migration mode from a channel in a team. Migration mode is a special state that prevents certain operations, like sending messages and adding members, during the data migration process. After a completeMigration request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response.user-id (string) required
team-id (string) required
get_users_by_user_id_joined_teams_by_team_id_primary_channel_does_user_have_access_user_id_@user_id_tenant_id_@tenant_id_user_principal_name_@user_principal_name_Determine whether a user has access to a channel.user-id (string) required
team-id (string) required
userId (string)
tenantId (string)
userPrincipalName (string)
post_users_by_user_id_joined_teams_by_team_id_primary_channel_provision_emailProvision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision an email address, you can call provisionEmail, or through the Teams user interface, select Get email address, which triggers Teams to generate an email address if it has not already provisioned one. To remove the email address of a channel, use the removeEmail method.user-id (string) required
team-id (string) required
post_users_by_user_id_joined_teams_by_team_id_primary_channel_remove_emailRemove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft Teams client.user-id (string) required
team-id (string) required
post_users_by_user_id_joined_teams_by_team_id_primary_channel_unarchiveRestore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive method. Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchiving operation completes successfully, which might occur after this method responds.user-id (string) required
team-id (string) required
get_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teamsA collection of teams with which a channel is shared.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teamsCreate new navigation property to sharedWithTeams for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_idA collection of teams with which a channel is shared.user-id (string) required
team-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_idUpdate the navigation property sharedWithTeams in usersuser-id (string) required
team-id (string) required
sharedWithChannelTeamInfo-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_idDelete navigation property sharedWithTeams for usersuser-id (string) required
team-id (string) required
sharedWithChannelTeamInfo-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_allowed_membersA collection of team members who have access to the shared channel.user-id (string) required
team-id (string) required
sharedWithChannelTeamInfo-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_by_conversation_member_idA collection of team members who have access to the shared channel.user-id (string) required
team-id (string) required
sharedWithChannelTeamInfo-id (string) required
conversationMember-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_allowed_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
sharedWithChannelTeamInfo-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_by_shared_with_channel_team_info_id_teamGet team from usersuser-id (string) required
team-id (string) required
sharedWithChannelTeamInfo-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_shared_with_teams_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_tabsA collection of all the tabs in the channel. A navigation property.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_primary_channel_tabsCreate new navigation property to tabs for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_primary_channel_tabs_by_teams_tab_idA collection of all the tabs in the channel. A navigation property.user-id (string) required
team-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_primary_channel_tabs_by_teams_tab_idUpdate the navigation property tabs in usersuser-id (string) required
team-id (string) required
teamsTab-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_primary_channel_tabs_by_teams_tab_idDelete navigation property tabs for usersuser-id (string) required
team-id (string) required
teamsTab-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_tabs_by_teams_tab_id_teams_appThe application that is linked to the tab. This can't be changed after tab creation.user-id (string) required
team-id (string) required
teamsTab-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_by_team_id_primary_channel_tabs_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_scheduleThe schedule of shifts for this team.user-id (string) required
team-id (string) required
$select (array)
$expand (array)
put_users_by_user_id_joined_teams_by_team_id_scheduleUpdate the navigation property schedule in usersuser-id (string) required
team-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_scheduleDelete navigation property schedule for usersuser-id (string) required
team-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_day_notesThe day notes in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_day_notesCreate new navigation property to dayNotes for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_day_notes_by_day_note_idThe day notes in the schedule.user-id (string) required
team-id (string) required
dayNote-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_day_notes_by_day_note_idUpdate the navigation property dayNotes in usersuser-id (string) required
team-id (string) required
dayNote-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_day_notes_by_day_note_idDelete navigation property dayNotes for usersuser-id (string) required
team-id (string) required
dayNote-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_day_notes_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
post_users_by_user_id_joined_teams_by_team_id_schedule_shareShare a schedule time range with schedule members. This action makes the collections of shift, openshift and timeOff items in the specified time range of the schedule viewable by the specified team members, including employees and managers. Each shift, openshift and timeOff instance in a schedule supports a draft version and a shared version of the item. The draft version is viewable by only managers, and the shared version is viewable by employees and managers. For each shift, openshift and timuser-id (string) required
team-id (string) required
data: {
. notifyTeam (boolean)
. startDateTime (string)
. endDateTime (string)
} (object) required
get_users_by_user_id_joined_teams_by_team_id_schedule_offer_shift_requestsThe offer requests for shifts in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_offer_shift_requestsCreate new navigation property to offerShiftRequests for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_offer_shift_requests_by_offer_shift_request_idThe offer requests for shifts in the schedule.user-id (string) required
team-id (string) required
offerShiftRequest-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_offer_shift_requests_by_offer_shift_request_idUpdate the navigation property offerShiftRequests in usersuser-id (string) required
team-id (string) required
offerShiftRequest-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_offer_shift_requests_by_offer_shift_request_idDelete navigation property offerShiftRequests for usersuser-id (string) required
team-id (string) required
offerShiftRequest-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_offer_shift_requests_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_open_shift_change_requestsThe open shift requests in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_open_shift_change_requestsCreate new navigation property to openShiftChangeRequests for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_open_shift_change_requests_by_open_shift_change_request_idThe open shift requests in the schedule.user-id (string) required
team-id (string) required
openShiftChangeRequest-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_open_shift_change_requests_by_open_shift_change_request_idUpdate the navigation property openShiftChangeRequests in usersuser-id (string) required
team-id (string) required
openShiftChangeRequest-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_open_shift_change_requests_by_open_shift_change_request_idDelete navigation property openShiftChangeRequests for usersuser-id (string) required
team-id (string) required
openShiftChangeRequest-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_open_shift_change_requests_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_open_shiftsThe set of open shifts in a scheduling group in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_open_shiftsCreate new navigation property to openShifts for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_open_shifts_by_open_shift_idThe set of open shifts in a scheduling group in the schedule.user-id (string) required
team-id (string) required
openShift-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_open_shifts_by_open_shift_idUpdate the navigation property openShifts in usersuser-id (string) required
team-id (string) required
openShift-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_open_shifts_by_open_shift_idDelete navigation property openShifts for usersuser-id (string) required
team-id (string) required
openShift-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_open_shifts_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_scheduling_groupsThe logical grouping of users in the schedule usually by role.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_scheduling_groupsCreate new navigation property to schedulingGroups for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_scheduling_groups_by_scheduling_group_idThe logical grouping of users in the schedule usually by role.user-id (string) required
team-id (string) required
schedulingGroup-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_scheduling_groups_by_scheduling_group_idUpdate the navigation property schedulingGroups in usersuser-id (string) required
team-id (string) required
schedulingGroup-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_scheduling_groups_by_scheduling_group_idDelete navigation property schedulingGroups for usersuser-id (string) required
team-id (string) required
schedulingGroup-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_scheduling_groups_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_shiftsThe shifts in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_shiftsCreate new navigation property to shifts for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_shifts_by_shift_idThe shifts in the schedule.user-id (string) required
team-id (string) required
shift-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_shifts_by_shift_idUpdate the navigation property shifts in usersuser-id (string) required
team-id (string) required
shift-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_shifts_by_shift_idDelete navigation property shifts for usersuser-id (string) required
team-id (string) required
shift-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_shifts_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_swap_shifts_change_requestsThe swap requests for shifts in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_swap_shifts_change_requestsCreate new navigation property to swapShiftsChangeRequests for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_swap_shifts_change_requests_by_swap_shifts_change_request_idThe swap requests for shifts in the schedule.user-id (string) required
team-id (string) required
swapShiftsChangeRequest-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_swap_shifts_change_requests_by_swap_shifts_change_request_idUpdate the navigation property swapShiftsChangeRequests in usersuser-id (string) required
team-id (string) required
swapShiftsChangeRequest-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_swap_shifts_change_requests_by_swap_shifts_change_request_idDelete navigation property swapShiftsChangeRequests for usersuser-id (string) required
team-id (string) required
swapShiftsChangeRequest-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_swap_shifts_change_requests_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_time_cardsThe time cards in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_time_cardsCreate new navigation property to timeCards for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_by_time_card_idThe time cards in the schedule.user-id (string) required
team-id (string) required
timeCard-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_by_time_card_idUpdate the navigation property timeCards in usersuser-id (string) required
team-id (string) required
timeCard-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_by_time_card_idDelete navigation property timeCards for usersuser-id (string) required
team-id (string) required
timeCard-id (string) required
If-Match (string)
post_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_by_time_card_id_clock_outInvoke action clockOutuser-id (string) required
team-id (string) required
timeCard-id (string) required
data: {
. isAtApprovedLocation (boolean)
. notes
} (object) required
post_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_by_time_card_id_confirmConfirm a timeCard.user-id (string) required
team-id (string) required
timeCard-id (string) required
post_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_by_time_card_id_end_breakInvoke action endBreakuser-id (string) required
team-id (string) required
timeCard-id (string) required
data: {
. isAtApprovedLocation (boolean)
. notes
} (object) required
post_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_by_time_card_id_start_breakInvoke action startBreakuser-id (string) required
team-id (string) required
timeCard-id (string) required
data: {
. isAtApprovedLocation (boolean)
. notes
} (object) required
get_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
post_users_by_user_id_joined_teams_by_team_id_schedule_time_cards_clock_inClock in to start a timeCard.user-id (string) required
team-id (string) required
data: {
. isAtApprovedLocation (boolean)
. onBehalfOfUserId (string)
. notes
} (object) required
get_users_by_user_id_joined_teams_by_team_id_schedule_time_off_reasonsThe set of reasons for a time off in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_time_off_reasonsCreate new navigation property to timeOffReasons for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_time_off_reasons_by_time_off_reason_idThe set of reasons for a time off in the schedule.user-id (string) required
team-id (string) required
timeOffReason-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_time_off_reasons_by_time_off_reason_idUpdate the navigation property timeOffReasons in usersuser-id (string) required
team-id (string) required
timeOffReason-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_time_off_reasons_by_time_off_reason_idDelete navigation property timeOffReasons for usersuser-id (string) required
team-id (string) required
timeOffReason-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_time_off_reasons_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_time_off_requestsThe time off requests in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_time_off_requestsCreate new navigation property to timeOffRequests for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_time_off_requests_by_time_off_request_idThe time off requests in the schedule.user-id (string) required
team-id (string) required
timeOffRequest-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_time_off_requests_by_time_off_request_idUpdate the navigation property timeOffRequests in usersuser-id (string) required
team-id (string) required
timeOffRequest-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_time_off_requests_by_time_off_request_idDelete navigation property timeOffRequests for usersuser-id (string) required
team-id (string) required
timeOffRequest-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_time_off_requests_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_times_offThe instances of times off in the schedule.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_schedule_times_offCreate new navigation property to timesOff for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_schedule_times_off_by_time_off_idThe instances of times off in the schedule.user-id (string) required
team-id (string) required
timeOff-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_schedule_times_off_by_time_off_idUpdate the navigation property timesOff in usersuser-id (string) required
team-id (string) required
timeOff-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_schedule_times_off_by_time_off_idDelete navigation property timesOff for usersuser-id (string) required
team-id (string) required
timeOff-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_schedule_times_off_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_tagsThe tags associated with the team.user-id (string) required
team-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_tagsCreate new navigation property to tags for usersuser-id (string) required
team-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_idThe tags associated with the team.user-id (string) required
team-id (string) required
teamworkTag-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_idUpdate the navigation property tags in usersuser-id (string) required
team-id (string) required
teamworkTag-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_idDelete navigation property tags for usersuser-id (string) required
team-id (string) required
teamworkTag-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_id_membersUsers assigned to the tag.user-id (string) required
team-id (string) required
teamworkTag-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_id_membersCreate new navigation property to members for usersuser-id (string) required
team-id (string) required
teamworkTag-id (string) required
data required
get_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_id_members_by_teamwork_tag_member_idUsers assigned to the tag.user-id (string) required
team-id (string) required
teamworkTag-id (string) required
teamworkTagMember-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_id_members_by_teamwork_tag_member_idUpdate the navigation property members in usersuser-id (string) required
team-id (string) required
teamworkTag-id (string) required
teamworkTagMember-id (string) required
data required
delete_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_id_members_by_teamwork_tag_member_idDelete navigation property members for usersuser-id (string) required
team-id (string) required
teamworkTag-id (string) required
teamworkTagMember-id (string) required
If-Match (string)
get_users_by_user_id_joined_teams_by_team_id_tags_by_teamwork_tag_id_members_countGet the number of the resourceuser-id (string) required
team-id (string) required
teamworkTag-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_tags_countGet the number of the resourceuser-id (string) required
team-id (string) required
$search (string)
get_users_by_user_id_joined_teams_by_team_id_templateThe template this team was created from. See available templates.user-id (string) required
team-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_joined_teams_countGet the number of the resourceuser-id (string) required
$search (string)
get_users_by_user_id_joined_teams_get_all_messages_Invoke function getAllMessagesuser-id (string) required
model (string)
$top (integer)
$select (array)
$orderby (array)
$expand (array)
get_users_by_user_id_teamworkGet the userTeamwork settings for a specified user, which includes the Microsoft Teams region and the locale chosen by the user.user-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_teamworkUpdate the navigation property teamwork in usersuser-id (string) required
data required
delete_users_by_user_id_teamworkDelete navigation property teamwork for usersuser-id (string) required
If-Match (string)
get_users_by_user_id_teamwork_associated_teamsThe list of associatedTeamInfo objects that a user is associated with.user-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_teamwork_associated_teamsCreate new navigation property to associatedTeams for usersuser-id (string) required
data required
get_users_by_user_id_teamwork_associated_teams_by_associated_team_info_idThe list of associatedTeamInfo objects that a user is associated with.user-id (string) required
associatedTeamInfo-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_teamwork_associated_teams_by_associated_team_info_idUpdate the navigation property associatedTeams in usersuser-id (string) required
associatedTeamInfo-id (string) required
data required
delete_users_by_user_id_teamwork_associated_teams_by_associated_team_info_idDelete navigation property associatedTeams for usersuser-id (string) required
associatedTeamInfo-id (string) required
If-Match (string)
get_users_by_user_id_teamwork_associated_teams_by_associated_team_info_id_teamGet team from usersuser-id (string) required
associatedTeamInfo-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_teamwork_associated_teams_countGet the number of the resourceuser-id (string) required
$search (string)
get_users_by_user_id_teamwork_installed_appsRetrieve the list of apps installed in the personal scope of the specified user.user-id (string) required
$top (integer)
$orderby (array)
$select (array)
$expand (array)
post_users_by_user_id_teamwork_installed_appsInstall an app in the personal scope of the specified user.user-id (string) required
data required
get_users_by_user_id_teamwork_installed_apps_by_user_scope_teams_app_installation_idRetrieve the app installed in the personal scope of the specified user.user-id (string) required
userScopeTeamsAppInstallation-id (string) required
$select (array)
$expand (array)
patch_users_by_user_id_teamwork_installed_apps_by_user_scope_teams_app_installation_idUpdate the navigation property installedApps in usersuser-id (string) required
userScopeTeamsAppInstallation-id (string) required
data required
delete_users_by_user_id_teamwork_installed_apps_by_user_scope_teams_app_installation_idUninstall an app from the personal scope of the specified user.user-id (string) required
userScopeTeamsAppInstallation-id (string) required
If-Match (string)
get_users_by_user_id_teamwork_installed_apps_by_user_scope_teams_app_installation_id_chatRetrieve the chat of the specified user and Teams app.user-id (string) required
userScopeTeamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_teamwork_installed_apps_by_user_scope_teams_app_installation_id_teams_appThe app that is installed.user-id (string) required
userScopeTeamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_teamwork_installed_apps_by_user_scope_teams_app_installation_id_teams_app_definitionThe details of this version of the app.user-id (string) required
userScopeTeamsAppInstallation-id (string) required
$select (array)
$expand (array)
get_users_by_user_id_teamwork_installed_apps_countGet the number of the resourceuser-id (string) required
$search (string)
post_users_by_user_id_teamwork_send_activity_notificationSend an activity feed notification to a user. For more information, see sending Teams activity notifications.user-id (string) required
data: {
. topic
. activityType (string)
. chainId (number)
. previewText
. teamsAppId (string)
. templateParameters (array)
. iconId (string)
} (object) required
customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body
_headers (object)