Skip to content

Microsoft Teams

Node: microsoftTeams · Full type: n8n-nodes-base.microsoftTeams · Version: 2

Credentials

microsoftTeamsOAuth2Api (alias: @microsoft)

CREDENTIAL @microsoft = microsoftTeamsOAuth2Api "My Microsoft Teams"

Operations

Resource: channel

create

Parameter Type Default Details
teamId resourceLocator {...} required; modes: list, url, id
name string "" required
options collection {} keys: description, type

deleteChannel

Parameter Type Default Details
teamId resourceLocator {...} required; modes: list, url, id
channelId resourceLocator {...} required; modes: list, id

get

Parameter Type Default Details
teamId resourceLocator {...} required; modes: list, url, id
channelId resourceLocator {...} required; modes: list, id

getAll

Parameter Type Default Details
teamId resourceLocator {...} required; modes: list, url, id
returnAll boolean false
limit number 100

update

Parameter Type Default Details
teamId resourceLocator {...} required; modes: list, url, id
channelId resourceLocator {...} required; modes: list, id
name string ""
options collection {} keys: description

Resource: channelMessage

create

Parameter Type Default Details
teamId resourceLocator {...} required; modes: list, url, id
channelId resourceLocator {...} required; modes: list, id
contentType options "text" required; text, html
message string "" required
options collection {} keys: includeLinkToWorkflow, makeReply

getAll

Parameter Type Default Details
teamId resourceLocator {...} required; modes: list, url, id
channelId resourceLocator {...} required; modes: list, id
returnAll boolean false
limit number 100

Resource: chatMessage

create

Parameter Type Default Details
chatId resourceLocator {...} required; modes: list, id
contentType options "text" required; text, html
message string "" required
options collection {} keys: includeLinkToWorkflow

get

Parameter Type Default Details
chatId resourceLocator {...} required; modes: list, id
messageId string "" required

getAll

Parameter Type Default Details
chatId resourceLocator {...} required; modes: list, id
returnAll boolean false
limit number 100

sendAndWait

Parameter Type Default Details
chatId resourceLocator {...} required; modes: list, id
message string "" required
responseType options "approval" approval, freeText, customForm
defineForm options "fields" fields, json
jsonOutput json "[
{
"fieldLabel": "Name",
"..."
formFields fixedCollection {} groups: values
formFields fixedCollection {} groups: values
approvalOptions fixedCollection {} groups: values
options collection {} keys: limitWaitTime, appendAttribution
options collection {} keys: messageButtonLabel, responseFormTitle, responseFormDescription, responseFormButtonLabel, responseFormCustomCss, limitWaitTime, ...

Resource: task

create

Parameter Type Default Details
groupId resourceLocator {...} required; modes: list, id
planId resourceLocator {...} required; modes: list, id
bucketId resourceLocator {...} required; modes: list, id
title string "" required
options collection {} keys: assignedTo, dueDateTime, percentComplete

deleteTask

Parameter Type Default Details
taskId string "" required

get

Parameter Type Default Details
taskId string "" required

getAll

Parameter Type Default Details
tasksFor options "member" required; member, plan
groupId resourceLocator {...} required; modes: list, id
planId resourceLocator {...} required; modes: list, id
returnAll boolean false
limit number 100

update

Parameter Type Default Details
taskId string "" required
updateFields collection {} keys: assignedTo, bucketId, dueDateTime, groupId, percentComplete, planId, ...

Parameter Details

options children:

Parameter Type Default Details
description string ""
type options "standard" private, standard

formFields children:

values group:

Parameter Type Default Details
fieldName string "" required
fieldLabel string "" required
fieldLabel string "" required
fieldName string ""
fieldType options "text" required; checkbox, html, date, dropdown, email, file, hiddenField, number, ... (12 total)
elementName string ""
fieldName string ""
placeholder string ""
defaultValue string ""
defaultValue dateTime ""
defaultValue string ""
defaultValue string ""
fieldValue string ""
fieldOptions fixedCollection {...} required; groups: values
fieldOptions fixedCollection {...} required; groups: values
fieldOptions fixedCollection {...} required; groups: values
multiselect boolean false
limitSelection options "unlimited" exact, range, unlimited
numberOfSelections number 1
minSelections number 0
maxSelections number 1
html string "

" | | | multipleFiles | boolean | true | | | acceptFileTypes | string | "" | | | requiredField | boolean | false | |

approvalOptions children:

values group:

Parameter Type Default Details
approvalType options "single" single, double
approveLabel string "✓ Approve"
disapproveLabel string "✗ Decline"

updateFields children:

Parameter Type Default Details
assignedTo resourceLocator {...} modes: list, id
bucketId resourceLocator {...} modes: list, id
dueDateTime string ""
groupId resourceLocator {...} modes: list, id
percentComplete number 0
planId resourceLocator {...} modes: list, id
title string ""

Example

NODE "microsoftTeams" @microsoft AS "Microsoft Teams" {
  resource: "channel",
  operation: "get",
  name: {{ $json.name }},
  message: {{ $json.message }},
  messageId: {{ $json.messageId }}
}