Microsoft Teams
The Microsoft Teams connector allows for the automation of team communication and collaboration tasks, facilitating efficient incident response and management within the Swimlane platform.
Microsoft Teams is a widely-used communication platform that enables collaboration through chat, meetings, and file sharing. The Microsoft Teams connector for Swimlane Turbine allows users to automate key communication tasks within their security workflows. By integrating with Microsoft Teams, Swimlane Turbine users can streamline incident response, coordinate team actions, and share critical information directly within the Teams environment, enhancing the overall efficiency and response time of security operations.
Prerequisites
To utilize the Microsoft Teams connector for Swimlane Turbine, ensure you have the following prerequisites:
- OAuth 2.0 Client Credentials authentication with these parameters:
- URL: Endpoint for Microsoft Teams API access
- Client ID: Application (client) ID registered in Azure AD
- Client Secret: Secret generated for the registered application
- Token URL: URL to obtain the OAuth2 token
- Scopes: Permissions required for the connector to interact with Microsoft Teams
- OAuth 2.0 Password Credentials authentication with these parameters:
- URL: Endpoint for Microsoft Teams API access
- OAuth2 Username: Username for OAuth2 authentication
- OAuth2 Password: Password for OAuth2 authentication
- Token URL: URL to obtain the OAuth2 token
- Client ID: Application (client) ID registered in Azure AD
- Scopes: Permissions required for the connector to interact with Microsoft Teams
- OAuth 2.0 Refresh Token authentication with these parameters:
- URL: Endpoint for Microsoft Teams API access ... and so on
Capabilities
In order to use actions within this connector you need to ensure you have created a Microsoft Teams team, you can use the Create Team action.
The Microsoft Teams integration provides the following capabilities using the Microsoft Graph API:
- Add Member to Channel
- Add Member to Team
- Create Channel
- Create Chat
- Create Team
- Get Channel filesFolder
- Get Chat by ID
- Get One on One Chat for User
- List Channel Messages
- List Chats
- List Chats by User ID
- List Messages in a Chat
- List pinnedChatMessages in a chat
- Pin a message in a chat
- Reply Channel Message ... and so on
Additional Information about Graph API Features
Certain actions within Microsoft Teams and the Microsoft Graph API are considered Protected APIs. You can request access here to use OAuth2's delegated authentication.
Webhook Considerations
In order to post messages to a channel in Microsoft Teams you must get the Webhook URL of your channel first. You will use the URL when creating the asset for the action.
Microsoft Graph Considerations
In order to use most actions within this connector, you must define the appropriate scopes for the action you are using. Below are a list of the action and their required scopes when registering an application in Microsoft Azure:
Delegated Permissions Per Task
- Add Members to a Channel
- ChannelMember.ReadWrite.All
- Add Members to a Team
- TeamMember.ReadWrite.All
- Create Channel
- Channel.Create
- Channel.Create.Group
- Directory.ReadWrite.All
- Group.ReadWrite.All
- Teamwork.Migrate.All
- Create Team
- Directory.ReadWrite.All
- Group.ReadWrite.All
- Team.Create
- Teamwork.Migrate.All ... and so on
Asset Setup
Microsoft Graph Setup
Steps to create the Azure app:
- Go to the App Registration page in the Azure portal.
- Click New Registration.

- Enter a name for your new application and choose Accounts in this organizational directory only, then click Register at the bottom.

- Navigate to the API permissions tab on the left navigation menu.

- Select Add a permission.

- Select Microsoft Graph.

- Select Application permissions or Delegated permissions, then mark all the permissions you need for the actions you are using (See suggested permissions at the top of the asset setup section).

- Click the Add permissions button at the bottom of the page.
- Select Grant admin consent for your organization, then your permissions should look as below.
- Navigate to the Certificates & secrets tab and select New client secret.

- Fill out the description and expiration, then click the Add button at the bottom.
- The Value of the secret you just created is the Client Secret needed for the Swimlane asset.



Authentication
The connector can be authenticated in one of two ways:
- Oauth 2.0 resource owner password credentials, which require a Username, Password, Token URL and Client ID. For more information, click here
- Oauth 2.0 client credentials flow, which requires a Client ID, Client Secret and Token URL. For more information, click here
- Oauth 2.0 refresh token grant, which requires a 'Refresh Token', 'Tenant ID', 'Client ID' and 'Client Secret'. Use this auth with accounts which have MFA enabled. To generate a refresh token please follow the instructions below.
- In step 3 of the above-mentioned setup instructions, please provide a 'Redirect URI' and select the platform as 'Web', before clicking on 'Register' at the the bottom.
- Proceed with the remaining steps to generate 'Client ID', 'Tenant ID' and 'Client Secret'.
- The Swimlane team will provide a Python script and instructions on how to use the script to generate the Refresh Token.
Notes
- For the Refresh Token Auth, The generated refresh token will have 90 days as the default expiry value unless it is reduced by your organization. You need to update the asset after the refresh token expires.
This connector was last tested against product version: Microsoft Graph V1 Endpoints
Additional Documentation
Configurations
MS Teams Client Credentials
Authenticates using oauth 2.0 client credentials
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
token_url | ο»Ώ | string | Required |
client_id | The client ID | string | Required |
client_secret | The client secret. | string | Required |
scope | Permission scopes for this action. | array | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
MS Teams Password Grant
Authenticates using oauth 2.0 password credentials
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
token_url | ο»Ώ | string | Required |
oauth2_username | The username for authentication | string | Required |
oauth2_password | The password for authentication | string | Required |
client_id | The client ID | string | Required |
client_secret | The client secret. | string | Optional |
scope | Permission scopes for this action. | array | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
MS Teams Refresh Token Grant
Authenticates using refresh token. Use this authentication for accounts with MFA enabled.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
tenant_id | ο»Ώ | string | Required |
cl_id | The client ID | string | Required |
cl_secret | The client secret. | string | Required |
refresh_token | Refresh Token. | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Add Member to Channel
Adds a new member to a private or shared Microsoft Teams channel, requiring team and channel IDs, roles, and user binding.
Endpoint
- URL: v1.0/teams/{{team-id}}/channels/{{channel-id}}/members
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.team-id | string | Required | Parameters for the Add Member to Channel action |
path_parameters.channel-id | string | Required | Parameters for the Add Member to Channel action |
@odata.type | string | Optional | Response data |
roles | array | Optional | Parameter for Add Member to Channel |
string | Optional | Response data |
Input Example
{"json_body":{"@odata.type":"#microsoft.graph.aadUserConversationMember","roles":["owner"],"[email protected]":"https://graph.microsoft.com/v1.0/users('3987e15d-f439-44e5-aa80-590fe116c266')"},"path_parameters":{"team-id":"2c435237-2587-4d26-a318-fc8537094d7b","channel-id":"19:[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
@odata.type | string | Response data |
id | string | Unique identifier |
roles | array | Output field: roles |
displayName | string | Name of the resource |
visibleHistoryStartDateTime | string | Time value |
userId | string | Unique identifier |
object | Output field: email | |
tenantId | string | Unique identifier |
Output Example
{"status_code":201,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://teamsgraph.teams.microsoft.com/v1.0/teams('2c435237-2587-4d26-a318-fc853...","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"b60b398a-aa14-41a6-a2db-e05e5230ad4e","client-request-id":"b60b398a-aa14-41a6-a2db-e05e5230ad4e","x-ms-ags-diagnostic":"{...
Create Channel
Creates a new channel within a specified team in Microsoft Teams, requiring the team's ID as a path parameter.
Endpoint
- URL: v1.0/teams/{{team-id}}/channels
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.team-id | string | Required | Parameters for the Create Channel action |
displayName | string | Optional | Name of the resource |
description | string | Optional | Parameter for Create Channel |
membershipType | string | Optional | Type of the resource |
@odata.type | string | Optional | Response data |
members | array | Optional | Parameter for Create Channel |
string | Optional | Response data | |
string | Optional | Response data | |
members.roles | array | Optional | Parameter for Create Channel |
@microsoft.graph.channelCreationMode | string | Optional | Parameter for Create Channel |
createdDateTime | string | Optional | Time value |
Input Example
{"json_body":{"displayName":"Architecture Discussion","description":"This channel is where we debate all future architecture plans","membershipType":"standard","@odata.type":"#Microsoft.Graph.channel","members":[{"@odata.type":"#microsoft.graph.aadUserConversationMember","[email protected]":"https://graph.microsoft.com/v1.0/users('62855810-484b-4823-9e01-60667f8b12ae')","roles":["owner"]}],"@microsoft.graph.channelCreationMode":"migration","createdDateTime":"2020-03-14T11:22:17.067Z"},"path_parameters":{"team-id":"2c435237-2587-4d26-a318-fc8537094d7b"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
createdDateTime | string | Time value |
displayName | string | Name of the resource |
description | string | Output field: description |
isFavoriteByDefault | boolean | Output field: isFavoriteByDefault |
string | Output field: email | |
webUrl | string | URL endpoint for the request |
membershipType | string | Type of the resource |
Output Example
{"status_code":201,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://teamsgraph.teams.microsoft.com/v1.0/teams('2c435237-2587-4d26-a318-fc853...","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"956b7f1f-cbe3-4478-bb64-d983f244a469","client-request-id":"956b7f1f-cbe3-4478-bb64-d983f244a469","x-ms-ags-diagnostic":"{...
Get Channel filesFolder
Retrieve metadata for the storage location of files within a specified Microsoft Teams channel, requiring team and channel IDs.
Endpoint
- URL: v1.0/teams/{{team-id}}/channels/{{channel-id}}/filesFolder
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.team-id | string | Required | Parameters for the Get Channel filesFolder action |
path_parameters.channel-id | string | Required | Parameters for the Get Channel filesFolder action |
Input Example
{"path_parameters":{"team-id":"2c435237-2587-4d26-a318-fc8537094d7b","channel-id":"19:[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
createdDateTime | string | Time value |
lastModifiedDateTime | string | Time value |
name | string | Name of the resource |
webUrl | string | URL endpoint for the request |
size | number | Output field: size |
parentReference | object | Output field: parentReference |
parentReference.driveId | string | Unique identifier |
parentReference.driveType | string | Type of the resource |
fileSystemInfo | object | Output field: fileSystemInfo |
fileSystemInfo.createdDateTime | string | Time value |
fileSystemInfo.lastModifiedDateTime | string | Time value |
folder | object | Output field: folder |
folder.childCount | number | Count value |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"95c5fefe-5c82-4364-b3d4-fa3223d4b5fb","client-request-id":"95c5fefe-5c82-4364-b3d4-fa3223d4b5fb","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South Central US\",\"Slice\":\"E\",\"Ring\":\"5\",\"ScaleUnit......
List Channel Messages
Retrieve messages from a specified Microsoft Teams channel, excluding replies. Requires 'team-id' and 'channel-id'.
Endpoint
- URL: v1.0/teams/{{team-id}}/channels/{{channel-id}}/messages
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.team-id | string | Required | Parameters for the List Channel Messages action |
path_parameters.channel-id | string | Required | Parameters for the List Channel Messages action |
parameters.$top | number | Optional | Parameters for the List Channel Messages action |
parameters.$expand | number | Optional | Parameters for the List Channel Messages action |
Input Example
{"parameters":{"$top":20,"$expand":1000},"path_parameters":{"team-id":"2c435237-2587-4d26-a318-fc8537094d7b","channel-id":"19:[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
@odata.count | number | Response data |
@odata.nextLink | string | Response data |
value | array | Value for the parameter |
value.id | string | Unique identifier |
value.replyToId | object | Unique identifier |
value.etag | string | Value for the parameter |
value.messageType | string | Type of the resource |
value.createdDateTime | string | Value for the parameter |
value.lastModifiedDateTime | string | Value for the parameter |
value.lastEditedDateTime | object | Value for the parameter |
value.deletedDateTime | object | Value for the parameter |
value.subject | object | Value for the parameter |
value.summary | object | Value for the parameter |
value.chatId | object | Unique identifier |
value.importance | string | Value for the parameter |
value.locale | string | Value for the parameter |
value.webUrl | string | URL endpoint for the request |
value.policyViolation | object | Value for the parameter |
value.eventDetail | object | Value for the parameter |
string | Response data | |
value.eventDetail.teamId | string | Unique identifier |
value.eventDetail.teamDescription | string | Value for the parameter |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://teamsgraph.teams.microsoft.com/v1.0/teams('2c435237-2587-4d26-a318-fc853...","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"956b7f1f-cbe3-4478-bb64-d983f244a469","client-request-id":"956b7f1f-cbe3-4478-bb64-d983f244a469","x-ms-ags-diagnostic":"{...
Reply Channel Message
Send a reply to a specific message within a Microsoft Teams channel, requiring the team-id, channel-id, message-id, and message body.
Endpoint
- URL: v1.0/teams/{{team-id}}/channels/{{channel-id}}/messages/{{message-id}}/replies
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.team-id | string | Required | Parameters for the Reply Channel Message action |
path_parameters.channel-id | string | Required | Parameters for the Reply Channel Message action |
path_parameters.message-id | string | Required | Parameters for the Reply Channel Message action |
attachments | array | Optional | Parameter for Reply Channel Message |
attachments.content | string | Optional | Response content |
attachments.contentType | string | Optional | Type of the resource |
attachments.contentUrl | string | Optional | URL endpoint for the request |
attachments.id | string | Optional | Unique identifier |
attachments.name | string | Optional | Name of the resource |
attachments.teamsAppId | string | Optional | Unique identifier |
attachments.thumbnailUrl | string | Optional | URL endpoint for the request |
body | object | Optional | Request body data |
body.content | string | Required | Request body data |
body.contentType | string | Optional | Request body data |
channelIdentity | object | Optional | Unique identifier |
channelIdentity.channelId | string | Optional | Unique identifier |
channelIdentity.teamId | string | Optional | Unique identifier |
chatId | string | Optional | Unique identifier |
createdDateTime | string | Optional | Time value |
deletedDateTime | string | Optional | Time value |
etag | string | Optional | Parameter for Reply Channel Message |
from | object | Optional | Parameter for Reply Channel Message |
from.application | object | Optional | Parameter for Reply Channel Message |
from.device | object | Optional | Parameter for Reply Channel Message |
from.conversation | object | Optional | Parameter for Reply Channel Message |
Input Example
{"path_parameters":{"team-id":"string","channel-id":"string","message-id":"string"},"attachments":[{"content":"string","contentType":"string","contentUrl":"string","id":"12345678-1234-1234-1234-123456789abc","name":"Example Name","teamsAppId":"string","thumbnailUrl":"string"}],"body":{"content":"string","contentType":"string"},"channelIdentity":{"channelId":"string","teamId":"string"},"chatId":"string","createdDateTime":"string","deletedDateTime":"string","etag":"string","from":{"application":{},"device":{},"conversation":{},"user":{"id":"12345678-1234-1234-1234-123456789abc","displayName":"Example Name","userIdentityType":"string"}},"id":"12345678-1234-1234-1234-123456789abc","importance":"string","lastEditedDateTime":"string","lastModifiedDateTime":"string","locale":"string","messageType":"string","replyToId":"string","subject":"string","summary":"string","webUrl":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
replyToId | string | Unique identifier |
etag | string | Output field: etag |
messageType | string | Type of the resource |
createdDateTime | string | Time value |
lastModifiedDateTime | string | Time value |
lastEditedDateTime | object | Time value |
deletedDateTime | object | Time value |
subject | object | Output field: subject |
summary | object | Output field: summary |
chatId | object | Unique identifier |
importance | string | Output field: importance |
locale | string | Output field: locale |
webUrl | string | URL endpoint for the request |
policyViolation | object | Output field: policyViolation |
eventDetail | object | Output field: eventDetail |
from | object | Output field: from |
from.application | object | Output field: from.application |
from.device | object | Output field: from.device |
from.user | object | Output field: from.user |
from.user.id | string | Unique identifier |
from.user.displayName | string | Name of the resource |
Output Example
{"status_code":201,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://teamsgraph.teams.microsoft.com/v1.0/teams('2c435237-2587-4d26-a318-fc853...","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"3bd868dd-1843-45b0-b08b-516f1ef2e8df","client-request-id":"3bd868dd-1843-45b0-b08b-516f1ef2e8df","x-ms-ags-diagnostic":"{...
Send Message to Channel
Sends a new chatMessage to a specified channel in Microsoft Teams, requiring the 'channel-id' and 'team-id'.
Endpoint
- URL: v1.0/teams/{{team-id}}/channels/{{channel-id}}/messages
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.channel-id | string | Required | Parameters for the Send Message to Channel action |
path_parameters.team-id | string | Required | Parameters for the Send Message to Channel action |
attachments | array | Optional | Parameter for Send Message to Channel |
attachments.content | string | Optional | Response content |
attachments.contentType | string | Optional | Type of the resource |
attachments.contentUrl | string | Optional | URL endpoint for the request |
attachments.id | string | Optional | Unique identifier |
attachments.name | string | Optional | Name of the resource |
attachments.teamsAppId | string | Optional | Unique identifier |
attachments.thumbnailUrl | string | Optional | URL endpoint for the request |
body | object | Optional | Request body data |
body.content | string | Required | Request body data |
body.contentType | string | Optional | Request body data |
channelIdentity | object | Optional | Unique identifier |
channelIdentity.channelId | string | Optional | Unique identifier |
channelIdentity.teamId | string | Optional | Unique identifier |
chatId | string | Optional | Unique identifier |
createdDateTime | string | Optional | Time value |
deletedDateTime | string | Optional | Time value |
etag | string | Optional | Parameter for Send Message to Channel |
from | object | Optional | Parameter for Send Message to Channel |
from.application | object | Optional | Parameter for Send Message to Channel |
from.device | object | Optional | Parameter for Send Message to Channel |
from.conversation | object | Optional | Parameter for Send Message to Channel |
from.user | object | Optional | Parameter for Send Message to Channel |
Input Example
{"path_parameters":{"channel-id":"string","team-id":"string"},"attachments":[{"content":"string","contentType":"string","contentUrl":"string","id":"12345678-1234-1234-1234-123456789abc","name":"Example Name","teamsAppId":"string","thumbnailUrl":"string"}],"body":{"content":"string","contentType":"string"},"channelIdentity":{"channelId":"string","teamId":"string"},"chatId":"string","createdDateTime":"string","deletedDateTime":"string","etag":"string","from":{"application":{},"device":{},"conversation":{},"user":{"id":"12345678-1234-1234-1234-123456789abc","displayName":"Example Name","userIdentityType":"string"}},"id":"12345678-1234-1234-1234-123456789abc","importance":"string","lastEditedDateTime":"string","lastModifiedDateTime":"string","locale":"string","messageType":"string","replyToId":"string","subject":"string","summary":"string","webUrl":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
replyToId | object | Unique identifier |
etag | string | Output field: etag |
messageType | string | Type of the resource |
createdDateTime | string | Time value |
lastModifiedDateTime | string | Time value |
lastEditedDateTime | object | Time value |
deletedDateTime | object | Time value |
subject | object | Output field: subject |
summary | object | Output field: summary |
chatId | object | Unique identifier |
importance | string | Output field: importance |
locale | string | Output field: locale |
webUrl | string | URL endpoint for the request |
policyViolation | object | Output field: policyViolation |
eventDetail | object | Output field: eventDetail |
from | object | Output field: from |
from.application | object | Output field: from.application |
from.device | object | Output field: from.device |
from.user | object | Output field: from.user |
from.user.id | string | Unique identifier |
from.user.displayName | string | Name of the resource |
Output Example
{"status_code":201,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://teamsgraph.teams.microsoft.com/v1.0/teams('2c435237-2587-4d26-a318-fc853...","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"c5d3a593-789e-4fb9-93b6-00ab6fca5b6d","client-request-id":"c5d3a593-789e-4fb9-93b6-00ab6fca5b6d","x-ms-ags-diagnostic":"{...
Create Chat
Initiates a new chat in Microsoft Teams with specified members and chat type. Requires 'chatType' and 'members' in the JSON body.
Endpoint
- URL: v1.0/chats
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
chatType | string | Optional | Type of the resource |
members | array | Optional | Parameter for Create Chat |
string | Optional | Response data | |
members.roles | array | Optional | Parameter for Create Chat |
string | Optional | Response data |
Input Example
{"json_body":{"chatType":"oneOnOne","members":[{"@odata.type":"#microsoft.graph.aadUserConversationMember","roles":["owner"],"[email protected]":"https://graph.microsoft.com/v1.0/users('3987e15d-f439-44e5-aa80-590fe116c266')"},{"@odata.type":"#microsoft.graph.aadUserConversationMember","roles":["owner"],"[email protected]":"https://graph.microsoft.com/v1.0/users('2b77f477-3a9f-4823-a882-6fb6cae8c7f9')"}]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
topic | object | Output field: topic |
createdDateTime | string | Time value |
lastUpdatedDateTime | string | Time value |
chatType | string | Type of the resource |
webUrl | string | URL endpoint for the request |
tenantId | string | Unique identifier |
viewpoint | object | Output field: viewpoint |
onlineMeetingInfo | object | Output field: onlineMeetingInfo |
Output Example
{"status_code":201,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://graph.microsoft.com","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"87834acd-0fba-48de-81f9-82f4db05f650","client-request-id":"87834acd-0fba-48de-81f9-82f4db05f650","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South Central US\",\"Sl...
Send Message to Chat
Sends a new chat message to a specified Microsoft Teams chat using the 'chat-id' and message 'body'.
Endpoint
- URL: v1.0/chats/{{chat-id}}/messages
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.chat-id | string | Required | Parameters for the Send Message to Chat action |
attachments | array | Optional | Parameter for Send Message to Chat |
attachments.content | string | Optional | Response content |
attachments.contentType | string | Optional | Type of the resource |
attachments.contentUrl | string | Optional | URL endpoint for the request |
attachments.id | string | Optional | Unique identifier |
attachments.name | string | Optional | Name of the resource |
attachments.teamsAppId | string | Optional | Unique identifier |
attachments.thumbnailUrl | string | Optional | URL endpoint for the request |
body | object | Optional | Request body data |
body.content | string | Required | Request body data |
body.contentType | string | Optional | Request body data |
channelIdentity | object | Optional | Unique identifier |
channelIdentity.channelId | string | Optional | Unique identifier |
channelIdentity.teamId | string | Optional | Unique identifier |
chatId | string | Optional | Unique identifier |
createdDateTime | string | Optional | Time value |
deletedDateTime | string | Optional | Time value |
etag | string | Optional | Parameter for Send Message to Chat |
from | object | Optional | Parameter for Send Message to Chat |
from.application | object | Optional | Parameter for Send Message to Chat |
from.device | object | Optional | Parameter for Send Message to Chat |
from.conversation | object | Optional | Parameter for Send Message to Chat |
from.user | object | Optional | Parameter for Send Message to Chat |
from.user.id | string | Optional | Unique identifier |
Input Example
{"path_parameters":{"chat-id":"string"},"attachments":[{"content":"string","contentType":"string","contentUrl":"string","id":"12345678-1234-1234-1234-123456789abc","name":"Example Name","teamsAppId":"string","thumbnailUrl":"string"}],"body":{"content":"string","contentType":"string"},"channelIdentity":{"channelId":"string","teamId":"string"},"chatId":"string","createdDateTime":"string","deletedDateTime":"string","etag":"string","from":{"application":{},"device":{},"conversation":{},"user":{"id":"12345678-1234-1234-1234-123456789abc","displayName":"Example Name","userIdentityType":"string"}},"id":"12345678-1234-1234-1234-123456789abc","importance":"string","lastEditedDateTime":"string","lastModifiedDateTime":"string","locale":"string","messageType":"string","replyToId":"string","subject":"string","summary":"string","webUrl":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
replyToId | object | Unique identifier |
etag | string | Output field: etag |
messageType | string | Type of the resource |
createdDateTime | string | Time value |
lastModifiedDateTime | string | Time value |
lastEditedDateTime | object | Time value |
deletedDateTime | object | Time value |
subject | object | Output field: subject |
summary | object | Output field: summary |
chatId | string | Unique identifier |
importance | string | Output field: importance |
locale | string | Output field: locale |
webUrl | object | URL endpoint for the request |
channelIdentity | object | Unique identifier |
policyViolation | object | Output field: policyViolation |
eventDetail | object | Output field: eventDetail |
from | object | Output field: from |
from.application | object | Output field: from.application |
from.device | object | Output field: from.device |
from.user | object | Output field: from.user |
from.user.id | string | Unique identifier |
Output Example
{"status_code":201,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://teamsgraph.teams.microsoft.com/v1.0/chats('19:2b77f477-3a9f-4823-a882-6f...","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"1e213b7f-a48e-4632-90b6-5ab2d6498b97","client-request-id":"1e213b7f-a48e-4632-90b6-5ab2d6498b97","x-ms-ags-diagnostic":"{...
Get Chat by ID
Retrieve details of a specific chat in Microsoft Teams using the unique chat ID.
Endpoint
- URL: v1.0/chats/{{chat-id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.chat-id | string | Required | Parameters for the Get Chat by ID action |
parameters.expand | string | Optional | Parameters for the Get Chat by ID action |
Input Example
{"parameters":{"expand":"lastMessagePreview"},"path_parameters":{"chat-id":"19:[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
OData-Version | string | Response data |
Date | string | Date value |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
topic | string | Output field: topic |
createdDateTime | string | Time value |
lastUpdatedDateTime | string | Time value |
chatType | string | Type of the resource |
webUrl | string | URL endpoint for the request |
tenantId | string | Unique identifier |
onlineMeetingInfo | object | Output field: onlineMeetingInfo |
viewpoint | object | Output field: viewpoint |
viewpoint.isHidden | boolean | Unique identifier |
viewpoint.lastMessageReadDateTime | string | Response message |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://graph.microsoft.com","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"87834acd-0fba-48de-81f9-82f4db05f650","client-request-id":"87834acd-0fba-48de-81f9-82f4db05f650","x-ms-ags-diagnostic":{"ServerInfo":{}}},"OData-Version":"4.0","Date":"Wed, 01 F...
Get One on One Chat for User
Retrieves a specific one-on-one chat for a user in Microsoft Teams using the provided user-id and chat-id.
Endpoint
- URL: v1.0/users/{{user-id}}/chats/{{chat-id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.user-id | string | Required | Parameters for the Get One on One Chat for User action |
path_parameters.chat-id | string | Required | Parameters for the Get One on One Chat for User action |
Input Example
{"path_parameters":{"user-id":"8b081ef6-4792-4def-b2c9-c363a1bf41d5","chat-id":"19:[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
topic | object | Output field: topic |
createdDateTime | string | Time value |
lastUpdatedDateTime | string | Time value |
chatType | string | Type of the resource |
webUrl | string | URL endpoint for the request |
tenantId | string | Unique identifier |
onlineMeetingInfo | object | Output field: onlineMeetingInfo |
viewpoint | object | Output field: viewpoint |
viewpoint.isHidden | boolean | Unique identifier |
viewpoint.lastMessageReadDateTime | string | Response message |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"dce591ab-03d2-4108-9425-3f28f44601ef","client-request-id":"dce591ab-03d2-4108-9425-3f28f44601ef","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00...","Date":"Wed, 31 Jan 2024 04:46:13 GMT"},"reason":"OK","json_bod...
List Chats
Retrieve a list of chat conversations for the currently logged-in user in Microsoft Teams, available with delegated authentication.
Endpoint
- URL: v1.0/chats/
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.$expand | string | Optional | Parameters for the List Chats action |
parameters.$top | number | Optional | Parameters for the List Chats action |
parameters.$filter | string | Optional | Parameters for the List Chats action |
parameters.$orderby | string | Optional | Parameters for the List Chats action |
Input Example
{"parameters":{"$expand":"members","$top":10,"$filter":"string","$orderby":"createdDateTime"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
@odata.count | number | Response data |
value | array | Value for the parameter |
value.id | string | Unique identifier |
value.topic | object | Value for the parameter |
value.createdDateTime | string | Value for the parameter |
value.lastUpdatedDateTime | string | Value for the parameter |
value.chatType | string | Type of the resource |
value.webUrl | string | URL endpoint for the request |
value.tenantId | string | Unique identifier |
value.onlineMeetingInfo | object | Value for the parameter |
value.viewpoint | object | Value for the parameter |
value.viewpoint.isHidden | boolean | Unique identifier |
value.viewpoint.lastMessageReadDateTime | string | Value for the parameter |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"75b62b4f-b645-4a6a-9b6f-10330ef25269","client-request-id":"75b62b4f-b645-4a6a-9b6f-10330ef25269","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00....
List Chats by User ID
Retrieve a list of chat conversations associated with a specified Microsoft Teams user ID.
Endpoint
- URL: v1.0/users/{{user_id}}/chats/
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.user_id | string | Required | Parameters for the List Chats by User ID action |
parameters.$expand | string | Optional | Parameters for the List Chats by User ID action |
parameters.$top | number | Optional | Parameters for the List Chats by User ID action |
parameters.$filter | string | Optional | Parameters for the List Chats by User ID action |
parameters.$orderby | string | Optional | Parameters for the List Chats by User ID action |
Input Example
{"parameters":{"$expand":"members","$top":10,"$filter":"string","$orderby":"createdDateTime"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
@odata.count | number | Response data |
value | array | Value for the parameter |
value.id | string | Unique identifier |
value.topic | object | Value for the parameter |
value.createdDateTime | string | Value for the parameter |
value.lastUpdatedDateTime | string | Value for the parameter |
value.chatType | string | Type of the resource |
value.webUrl | string | URL endpoint for the request |
value.tenantId | string | Unique identifier |
value.onlineMeetingInfo | object | Value for the parameter |
value.viewpoint | object | Value for the parameter |
value.viewpoint.isHidden | boolean | Unique identifier |
value.viewpoint.lastMessageReadDateTime | string | Value for the parameter |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"90cdf9d9-4e8d-4fec-9556-d3d796378d70","client-request-id":"90cdf9d9-4e8d-4fec-9556-d3d796378d70","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00....
List Messages in a Chat
Retrieve a list of messages from a specified chat in Microsoft Teams using the chat_id.
Endpoint
- URL: /v1.0/chats/{{chat_id}}/messages
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.chat_id | string | Required | Parameters for the List Messages in a Chat action |
parameters.$top | number | Optional | Parameters for the List Messages in a Chat action |
parameters.$orderby | string | Optional | Parameters for the List Messages in a Chat action |
parameters.$filter | string | Optional | Parameters for the List Messages in a Chat action |
Input Example
{"parameters":{"top":5,"orderby":"","filter":"Subject eq 'welcome'"},"path_parameters":{"chat_id":"19:[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
@odata.count | number | Response data |
@odata.nextLink | string | Response data |
value | array | Value for the parameter |
value.id | string | Unique identifier |
value.replyToId | object | Unique identifier |
value.etag | string | Value for the parameter |
value.messageType | string | Type of the resource |
value.createdDateTime | string | Value for the parameter |
value.lastModifiedDateTime | string | Value for the parameter |
value.lastEditedDateTime | object | Value for the parameter |
value.deletedDateTime | object | Value for the parameter |
value.subject | object | Value for the parameter |
value.summary | object | Value for the parameter |
value.chatId | string | Unique identifier |
value.importance | string | Value for the parameter |
value.locale | string | Value for the parameter |
value.webUrl | object | URL endpoint for the request |
value.channelIdentity | object | Unique identifier |
value.policyViolation | object | Value for the parameter |
value.eventDetail | object | Value for the parameter |
value.from | object | Value for the parameter |
value.from.application | object | Value for the parameter |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"be6e1664-c548-43c2-af1f-db4ab3c2ed16","client-request-id":"be6e1664-c548-43c2-af1f-db4ab3c2ed16","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00....
List pinnedChatMessages in a chat
Retrieve all pinned chat messages from a specified Microsoft Teams chat using the chat-id.
Endpoint
- URL: /chats/{{chat-id}}/pinnedMessages
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.chat-id | string | Required | The ID of the chat. |
parameters.$expand | number | Optional | Parameters for the List pinnedChatMessages in a chat action |
Input Example
{"path_parameters":{"chat-id":"string"},"parameters":{"$expand":123}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
value | array | Value for the parameter |
string | Response data | |
value.id | string | Unique identifier |
Output Example
{"status_code":200,"reason":"OK","json_body":{"value":[{},{}]}}
Pin a message in a chat
Pins a specified message within an existing Microsoft Teams chat using the chat's ID. Requires an existing chat ID.
Endpoint
- URL: /chats/{{chat-id}}/pinnedMessages
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.chat-id | string | Required | The ID of the chat. |
headers | object | Optional | Headers |
headers.Content-Type | string | Required | The content type of the request. |
Input Example
{"path_parameters":{"chat-id":"string"},"headers":{"Content-Type":"application/json"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.type | string | Response data |
id | string | Unique identifier |
Output Example
{"status_code":201,"reason":"Created","json_body":{"@odata.type":"#microsoft.graph.pinnedChatMessageInfo","id":"1616964509832"}}
Add Member to Team
Adds a new member to a specified Microsoft Teams team, requiring the team's ID and member details such as type, roles, and user binding.
Endpoint
- URL: v1.0/teams/{{team-id}}/members
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.team-id | string | Required | Parameters for the Add Member to Team action |
@odata.type | string | Optional | Response data |
roles | array | Optional | Parameter for Add Member to Team |
string | Optional | Response data |
Input Example
{"json_body":{"@odata.type":"#microsoft.graph.aadUserConversationMember","roles":["owner"],"[email protected]":"https://graph.microsoft.com/v1.0/users('3987e15d-f439-44e5-aa80-590fe116c266')"},"path_parameters":{"team-id":"2c435237-2587-4d26-a318-fc8537094d7b"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
@odata.type | string | Response data |
id | string | Unique identifier |
roles | array | Output field: roles |
displayName | string | Name of the resource |
visibleHistoryStartDateTime | string | Time value |
userId | string | Unique identifier |
object | Output field: email | |
tenantId | string | Unique identifier |
Output Example
{"status_code":201,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Location":"https://teamsgraph.teams.microsoft.com/v1.0/teams('2c435237-2587-4d26-a318-fc853...","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"c8fbe719-da69-45c7-bc1a-f6395c5e8d53","client-request-id":"c8fbe719-da69-45c7-bc1a-f6395c5e8d53","x-ms-ags-diagnostic":"{...
Create Team
Creates a new team in Microsoft Teams with specified details provided in the JSON body and headers.
Endpoint
- URL: v1.0/teams
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
headers | object | Required | HTTP headers for the request |
headers.Content-Type | string | Required | HTTP headers for the request |
string | Optional | Response data | |
displayName | string | Optional | Name of the resource |
description | string | Optional | Parameter for Create Team |
members | array | Optional | Parameter for Create Team |
string | Optional | Response data | |
members.roles | array | Optional | Parameter for Create Team |
string | Optional | Response data | |
visibility | string | Optional | Parameter for Create Team |
channels | array | Optional | Parameter for Create Team |
channels.displayName | string | Optional | Name of the resource |
channels.isFavoriteByDefault | boolean | Optional | Parameter for Create Team |
channels.description | string | Optional | Parameter for Create Team |
channels.tabs | array | Optional | Parameter for Create Team |
string | Optional | Response data | |
channels.tabs.displayName | string | Optional | Name of the resource |
channels.tabs.configuration | object | Optional | Parameter for Create Team |
channels.tabs.configuration.contentUrl | string | Optional | URL endpoint for the request |
channels.tabs.configuration.websiteUrl | string | Optional | URL endpoint for the request |
memberSettings | object | Optional | Parameter for Create Team |
memberSettings.allowCreateUpdateChannels | boolean | Optional | Parameter for Create Team |
memberSettings.allowDeleteChannels | boolean | Optional | Parameter for Create Team |
memberSettings.allowAddRemoveApps | boolean | Optional | Parameter for Create Team |
memberSettings.allowCreateUpdateRemoveTabs | boolean | Optional | Parameter for Create Team |
Input Example
{"json_body":{"[email protected]":"https://graph.microsoft.com/v1.0/teamsTemplates('standard')","displayName":"My Sample Team","description":"My Sample Team\u2019s Description","members":[{"@odata.type":"#microsoft.graph.aadUserConversationMember","roles":["owner"],"[email protected]":"https://graph.microsoft.com/v1.0/users('0040b377-61d8-43db-94f5-81374122dc7e')"}],"visibility":"Private","channels":[{"displayName":"Announcements \ud83d\udce2","isFavoriteByDefault":true,"description":"This is a sample announcements channel that is favorited by default. Use this channel to make important team, product, and service announcements."},{"displayName":"Training \ud83c\udfcb\ufe0f","isFavoriteByDefault":true,"description":"This is a sample training channel, that is favorited by default, and contains an example of pinned website and YouTube tabs.","tabs":[{"[email protected]":"https://graph.microsoft.com/v1.0/appCatalogs/teamsApps('com.microsoft.teamspace.tab.web')","displayName":"A Pinned Website","configuration":{"contentUrl":"https://learn.microsoft.com/microsoftteams/microsoft-teams"}},{"[email protected]":"https://graph.microsoft.com/v1.0/appCatalogs/teamsApps('com.microsoft.teamspace.tab.youtube')","displayName":"A Pinned YouTube Video","configuration":{"contentUrl":"https://tabs.teams.microsoft.com/Youtube/Home/YoutubeTab?videoId=X8krAMdGvCQ","websiteUrl":"https://www.youtube.com/watch?v=X8krAMdGvCQ"}}]},{"displayName":"Planning \ud83d\udcc5 ","description":"This is a sample of a channel that is not favorited by default, these channels will appear in the more channels overflow menu.","isFavoriteByDefault":false},{"displayName":"Issues and Feedback \ud83d\udc1e","description":"This is a sample of a channel that is not favorited by default, these channels will appear in the more channels overflow menu."}],"memberSettings":{"allowCreateUpdateChannels":true,"allowDeleteChannels":true,"allowAddRemoveApps":true,"allowCreateUpdateRemoveTabs":true,"allowCreateUpdateRemoveConnectors":true},"guestSettings":{"allowCreateUpdateChannels":false,"allowDeleteChannels":false},"funSettings":{"allowGiphy":true,"giphyContentRating":"Moderate","allowStickersAndMemes":true,"allowCustomMemes":true},"messagingSettings":{"allowUserEditMessages":true,"allowUserDeleteMessages":true,"allowOwnerDeleteMessages":true,"allowTeamMentions":true,"allowChannelMentions":true},"discoverySettings":{"showInTeamsSearchAndSuggestions":true},"installedApps":[{"[email protected]":"https://graph.microsoft.com/v1.0/appCatalogs/teamsApps('com.microsoft.teamspace.tab.vsts')"},{"[email protected]":"https://graph.microsoft.com/v1.0/appCatalogs/teamsApps('1542629c-01b3-4a6d-8f76-1938b779e48d')"}],"[email protected]":"https://graph.microsoft.com/v1.0/groups('71392b2f-1765-406e-86af-5907d9bdb2ab')","@microsoft.graph.teamCreationMode":"migration","createdDateTime":"2020-03-14T11:22:17.067Z"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response_text | string | Output field: response_text |
Output Example
{"status_code":202,"response_headers":{"Content-Location":"/teams('454d3685-9ae8-476d-80fd-2d607e5b8d9d')","Location":"/teams('454d3685-9ae8-476d-80fd-2d607e5b8d9d')/operations('38613ae4-0012-462c-b7...","Strict-Transport-Security":"max-age=31536000","request-id":"a181d619-2cd5-400e-a60c-fcde238c8af7","client-request-id":"a181d619-2cd5-400e-a60c-fcde238c8af7","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South Central US\",\"Slice\":\"E\",\"Ring\":\"5\",\"ScaleUnit...","Date":"Fri, 27...
Unpin a message from a chat
Removes a pinned message from a specified chat in Microsoft Teams using the chat-id and pinnedChatMessageId.
Endpoint
- URL: DELETE /chats/{{chat-id}}/pinnedMessages/{{pinnedChatMessageId}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.chat-id | string | Required | The ID of the chat. |
path_parameters.pinnedChatMessageId | string | Required | The ID of the pinned chat message. |
Input Example
{"path_parameters":{"chat-id":"string","pinnedChatMessageId":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"reason":"No Content"}
Update Chat
Updates the topic of a specified chat in Microsoft Teams using the chat-id and a new topic value.
Endpoint
- URL: v1.0/chats/{{chat-id}}
- Method: PATCH
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.chat-id | string | Required | Parameters for the Update Chat action |
topic | string | Optional | The title of the chat. This can only be set for a chat with a chatType value of group. Maximum length is 250 characters. Use of ':' is not allowed. |
Input Example
{"json_body":{"topic":"Group chat title update"},"path_parameters":{"chat-id":"19:[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
@odata.context | string | Response data |
id | string | Unique identifier |
topic | string | Output field: topic |
createdDateTime | string | Time value |
lastUpdatedDateTime | string | Time value |
chatType | string | Type of the resource |
Output Example
{"status_code":200,"response_headers":{"Transfer-Encoding":"chunked","Content-Type":"application/json","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"dce591ab-03d2-4108-9425-3f28f44601ef","client-request-id":"dce591ab-03d2-4108-9425-3f28f44601ef","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00...","Date":"Wed, 31 Jan 2024 04:46:13 GMT"},"reason":"OK","json_bod...
Response Headers
Header | Description | Example |
|---|---|---|
client-request-id | HTTP response header: client-request-id | 87834acd-0fba-48de-81f9-82f4db05f650 |
Content-Encoding | HTTP response header: Content-Encoding | gzip |
Content-Length | The length of the response body in bytes | 0 |
Content-Location | HTTP response header: Content-Location | /teams('454d3685-9ae8-476d-80fd-2d607e5b8d9d') |
Content-Type | The media type of the resource | application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false;charset=utf-8 |
Date | The date and time at which the message was originated | Wed, 01 Feb 2023 21:13:27 GMT |
Location | The URL to redirect a page to | |
OData-Version | HTTP response header: OData-Version | 4.0 |
request-id | HTTP response header: request-id | c5d3a593-789e-4fb9-93b6-00ab6fca5b6d |
Strict-Transport-Security | HTTP response header: Strict-Transport-Security | max-age=31536000 |
Transfer-Encoding | HTTP response header: Transfer-Encoding | chunked |
Vary | HTTP response header: Vary | Accept-Encoding |
x-ms-ags-diagnostic | HTTP response header: x-ms-ags-diagnostic | {"ServerInfo":{"DataCenter":"South India","Slice":"E","Ring":"2","ScaleUnit":"001","RoleInstance":"MA1PEPF00007814"}} |