Microsoft Teams (Preview)

Microsoft Teams enables you to get all your content, tools and conversations in the Team workspace with Office 365.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://products.office.com/microsoft-teams/group-chat-software

Known issues and limitations

  1. The Microsoft Teams "When a new channel message is added" trigger only fires when root messages are added in the channel. Replies to an existing channel message will not result in the trigger event firing.
  2. The message size limit for the "Post a message" action is approximately 28KB. This encompasses all HTML elements like text, images, links, tables, mentions and so on. If the message exceeds 28KB the action will fail with an error stating: "Request Entity too large"

Throttling Limits

Name Calls Renewal Period
Non-Get requests per connection3003600 seconds

Actions

Create a channel

This operation is used to create a new channel for a specific Team.

Get @mention token for a user

This operation creates a token that can be inserted into a message or adaptive card to @mention a user.

Get a team

This operation returns details for a team using the team's unique ID.

Get messages

This operation is used to get messages from a channel in a specific Team.

List channels

This operation retrieves a list of all the channels for a specific Team.

List teams

This operation retrieves a list of all the Teams (Office 365 Groups) you are a member of.

Post a choice of options as the Flow bot to a user

Easily automate the process of sending a message to a Teams user that contains a set of options they must choose from before they respond.

Post a message (V2)

This operation is used to post a message to a channel in a specific Team.

Post a message (V3)

This operation is used to post a message to a channel in a specific Team.

Post a message [DEPRECATED]

This action has been deprecated. Please use Post a message (V3) instead.

This operation is used to post a message to a channel in a specific Team.

Post a message as the Flow bot to a channel

Easily automate the process of posting a message to a Teams channel.

Post a message as the Flow bot to a user

Easily automate the process of sending a message to someone in Teams.

Post a reply to a message

This operation is used to post a reply to a message in a channel in a specific Team.

Post a reply to a message (V2)

This operation is used to post a reply to a message in a channel in a specific Team.

Post an Adaptive Card to a Teams channel and wait for a response

Easily automate the process of sending a message to a Teams channel that contains actions to continue a waiting flow.

Post an Adaptive Card to a Teams user and wait for a response

Easily automate the process of sending a message to a Teams user that contains actions to continue a waiting flow.

Post your own adaptive card as the Flow bot to a channel

Add the JSON card definition to create a custom post for a Teams channel. The post can contain images, graphs, text, and more.

Post your own adaptive card as the Flow bot to a user

Add the JSON card definition to create a custom message for a Teams user. The message can contain images, graphs, text, and more.

Shifts: Approve a Swap Shifts request [DEPRECATED]

This action has been deprecated. Please use Approve a Swap Shifts request instead.

This operation allows a user to approve a Swap Shifts request.

Shifts: Approve a Time Off request [DEPRECATED]

This action has been deprecated. Please use Approve a Time Off request instead.

This operation allows managers to approve a time off request.

Shifts: Approve an Offer Shift request [DEPRECATED]

This action has been deprecated. Please use Approve an Offer Shift request instead.

This operation allows recipients/managers to approve an offer shift request.

Shifts: Approve an Open Shift request [DEPRECATED]

This action has been deprecated. Please use Approve an Open Shift request instead.

This operation allows managers to approve an Open Shift request.

Shifts: Create a new Open Shift [DEPRECATED]

This action has been deprecated. Please use Create a new Open Shift instead.

Create a new open shift in a schedule

Shifts: Decline a Swap Shifts request [DEPRECATED]

This action has been deprecated. Please use Decline a Swap Shifts request instead.

This operation allows users to decline a swap shifts request.

Shifts: Decline a Time Off request [DEPRECATED]

This action has been deprecated. Please use Decline a Time Off request instead.

This operation allows managers to decline a time off request.

Shifts: Decline an Offer Shift request [DEPRECATED]

This action has been deprecated. Please use Decline an Offer Shift request instead.

This operation allows users to decline an offer shift request.

Shifts: Decline an Open Shift request [DEPRECATED]

This action has been deprecated. Please use Decline an Open Shift request instead.

This operation allows managers to decline an open shift request.

Shifts: Delete a shift [DEPRECATED]

This action has been deprecated. Please use Delete a shift instead.

This operation deletes a shift using the shift's unique ID.

Shifts: Delete an open shift [DEPRECATED]

This action has been deprecated. Please use Delete an open shift instead.

This operation deletes an open shift.

Shifts: Get a schedule's details [DEPRECATED]

This action has been deprecated. Please use Get a schedule's details instead.

This operation returns details of a schedule using the schedule's unique ID.

Shifts: Get a scheduling group [DEPRECATED]

This action has been deprecated. Please use Get a scheduling group instead.

This operation returns details for a scheduling group using its unique ID.

Shifts: Get a shift [DEPRECATED]

This action has been deprecated. Please use Get a shift instead.

This operation returns details for a shift using the shift's unique ID.

Shifts: Get an open shift [DEPRECATED]

This action has been deprecated. Please use Get an open shift instead.

This operation returns details for an open shift.

Shifts: List all Offer Shift requests [DEPRECATED]

This action has been deprecated. Please use List all Offer Shift requests instead.

This operation returns all offer shift requests in a schedule

Shifts: List all Open Shift requests [DEPRECATED]

This action has been deprecated. Please use List all Open Shift requests instead.

This operation returns all open shift change requests in a schedule

Shifts: List all Open Shifts [DEPRECATED]

This action has been deprecated. Please use List all Open Shifts instead.

This operation returns all open shifts in a team

Shifts: List all scheduling groups [DEPRECATED]

This action has been deprecated. Please use List all scheduling groups instead.

This operation returns all scheduling groups in a schedule

Shifts: List all shifts [DEPRECATED]

This action has been deprecated. Please use List all shifts instead.

This operation returns all shifts assigned to members of a team

Shifts: List all Swap Shifts requests [DEPRECATED]

This action has been deprecated. Please use List all Swap Shifts requests instead.

This operation returns all swap shifts requests in a schedule

Shifts: List all Time Off reasons [DEPRECATED]

This action has been deprecated. Please use List all Time Off reasons instead.

This operation returns the list of time off reasons associated with a team.

Shifts: List all Time Off requests [DEPRECATED]

This action has been deprecated. Please use List all Time Off requests instead.

This operation returns all time off requests in a schedule

Shifts: Update an Open Shift [DEPRECATED]

This action has been deprecated. Please use Update an Open Shift instead.

Update an open shift in a schedule.

Create a channel

This operation is used to create a new channel for a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Description
description string

More information about the channel.

Display Name
displayName True string

Name of the channel.

Returns

Name Path Type Description
Description
description string

More information about the channel.

Display Name
displayName string

Name of the channel.

Id
id string

Unique ID of the channel.

Get @mention token for a user

This operation creates a token that can be inserted into a message or adaptive card to @mention a user.

Parameters

Name Key Required Type Description
User
userId True email

Specify a user to @mention

Returns

@mention Token

Get a team

This operation returns details for a team using the team's unique ID.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Returns

Get team response

Get messages

This operation is used to get messages from a channel in a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Returns

List channels

This operation retrieves a list of all the channels for a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Returns

Name Path Type Description
Channel List
value array of object

List of one or more channels for a specific Team.

Description
value.description string

More information about the channel.

Name
value.displayName string

Brief summary of the channel.

Id
value.id string

Unique ID of the channel.

List teams

This operation retrieves a list of all the Teams (Office 365 Groups) you are a member of.

Returns

Name Path Type Description
Teams List
value array of object

List of one or more Teams you are a part of.

Description
value.description string

More information about the Team.

Name
value.displayName string

Brief summary of the Team.

Id
value.id string

Unique ID of the Team (O365 group).

Post a choice of options as the Flow bot to a user

Easily automate the process of sending a message to a Teams user that contains a set of options they must choose from before they respond.

Parameters

Name Key Required Type Description
User message with options subscription request
UserMessageWithOptionsSubscriptionRequest True dynamic

The user message with options subscription request

Returns

The outputs of this operation are dynamic.

Post a message (V2)

This operation is used to post a message to a channel in a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Subject
subject string

Subject of the message.

Message
content True string

Body of the message.

Type
contentType True string

Content type: html or text.

Post a message (V3)

This operation is used to post a message to a channel in a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Subject
subject string

Subject of the message.

Message
content True html

Body of the message.

Returns

Body
MessageId

Post a message [DEPRECATED]

This action has been deprecated. Please use Post a message (V3) instead.

This operation is used to post a message to a channel in a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Message
content True html

Body of the message.

Post a message as the Flow bot to a channel

Easily automate the process of posting a message to a Teams channel.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Post notification request
PostNotificationRequest True dynamic

The post notification request

Post a message as the Flow bot to a user

Easily automate the process of sending a message to someone in Teams.

Parameters

Name Key Required Type Description
Post notification request
PostNotificationRequest True dynamic

The post notification request

Post a reply to a message

This operation is used to post a reply to a message in a channel in a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Message
messageId True string

Add Teams message ID

Subject
subject string

Subject of the message.

Reply
content True string

Body of the message.

Type
contentType True string

Content type: html or text.

Post a reply to a message (V2)

This operation is used to post a reply to a message in a channel in a specific Team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Message
messageId True string

Add Teams message ID

Subject
subject string

Subject of the message.

Reply
content True html

Body of the message.

Post an Adaptive Card to a Teams channel and wait for a response

Easily automate the process of sending a message to a Teams channel that contains actions to continue a waiting flow.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Update message
updateMessage string

Message to be included in an update to the original card following response

Should update card
shouldUpdateCard boolean

Whether or not to update the card following response

Channel
channelId True string

Add Teams channel ID

Message
messageBody True string

Add Team ID

Returns

The outputs of this operation are dynamic.

Post an Adaptive Card to a Teams user and wait for a response

Easily automate the process of sending a message to a Teams user that contains actions to continue a waiting flow.

Parameters

Name Key Required Type Description
Update message
updateMessage string

Message to be included in an update to the original card following response

Should update card
shouldUpdateCard boolean

Whether or not to update the card following response

Recipient
to True string

Add an email address

Summary
summary string

The message summary

IsAlert
isAlert boolean

If the message will be shown in the activity feed

Message
messageBody True string

Message to be included in an update to the original card following response

Returns

The outputs of this operation are dynamic.

Post your own adaptive card as the Flow bot to a channel

Add the JSON card definition to create a custom post for a Teams channel. The post can contain images, graphs, text, and more.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Post adaptive card request
PostAdaptiveCardRequest True dynamic

The post adaptive card request

Returns

Body
MessageId

Post your own adaptive card as the Flow bot to a user

Add the JSON card definition to create a custom message for a Teams user. The message can contain images, graphs, text, and more.

Parameters

Name Key Required Type Description
Post adaptive card request
PostAdaptiveCardRequest True dynamic

The post adaptive card request

Returns

Body
MessageId

Shifts: Approve a Swap Shifts request [DEPRECATED]

This action has been deprecated. Please use Approve a Swap Shifts request instead.

This operation allows a user to approve a Swap Shifts request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Swap Shifts Change Request ID
swapShiftsChangeRequestId True string

The unique ID of the request

Message From Recipient/Manager
message string

A message when a request is accepted.

Returns

Shifts: Approve a Time Off request [DEPRECATED]

This action has been deprecated. Please use Approve a Time Off request instead.

This operation allows managers to approve a time off request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Time Off Request ID
timeOffRequestId True string

The unique ID of the time off request

Message From Manager
message string

A message from the manager to the sender/recipient when a request is accepted.

Returns

Shifts: Approve an Offer Shift request [DEPRECATED]

This action has been deprecated. Please use Approve an Offer Shift request instead.

This operation allows recipients/managers to approve an offer shift request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Offer Shift Request ID
offerShiftRequestId True string

The unique ID of the offer shift request

Message From Recipient/Manager
message string

A message when a request is accepted.

Returns

Shifts: Approve an Open Shift request [DEPRECATED]

This action has been deprecated. Please use Approve an Open Shift request instead.

This operation allows managers to approve an Open Shift request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Open Shift Change Request ID
openShiftChangeRequestId True string

The unique ID of the request

Message From Manager
message string

A message from the manager to the sender/recipient when a request is accepted.

Returns

Shifts: Create a new Open Shift [DEPRECATED]

This action has been deprecated. Please use Create a new Open Shift instead.

Create a new open shift in a schedule

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Scheduling Group ID
schedulingGroupId string

Scheduling Group ID

Display Name
displayName string

Display Name

Notes
notes string

Notes

From Start Time
startDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Theme
theme string

Theme

Open Slot Count
openSlotCount True integer

Open Slot Count

Is Paid
isPaid boolean

Is Paid

From Start Time
startDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Code
code string

Code

Display Name
displayName string

Display Name

Returns

Open Shift Entity

Open Shift
OpenShiftResponse

Shifts: Decline a Swap Shifts request [DEPRECATED]

This action has been deprecated. Please use Decline a Swap Shifts request instead.

This operation allows users to decline a swap shifts request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Swap Shifts Change Request ID
swapShiftsChangeRequestId True string

The unique ID of the request

Message From Recipient/Manager
message string

A message when a request is declined.

Returns

Shifts: Decline a Time Off request [DEPRECATED]

This action has been deprecated. Please use Decline a Time Off request instead.

This operation allows managers to decline a time off request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Time Off Request ID
timeOffRequestId True string

The unique ID of the time off request

Message From Manager
message string

A message from the manager to the sender/recipient when a request is declined.

Returns

Shifts: Decline an Offer Shift request [DEPRECATED]

This action has been deprecated. Please use Decline an Offer Shift request instead.

This operation allows users to decline an offer shift request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Offer Shift Request ID
offerShiftRequestId True string

The unique ID of the offer shift request

Message From Recipient/Manager
message string

A message when a request is declined.

Returns

Shifts: Decline an Open Shift request [DEPRECATED]

This action has been deprecated. Please use Decline an Open Shift request instead.

This operation allows managers to decline an open shift request.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Open Shift Change Request ID
openShiftChangeRequestId True string

The unique ID of the request

Message From Manager
message string

A message from the manager to the sender/recipient when a request is declined.

Returns

Shifts: Delete a shift [DEPRECATED]

This action has been deprecated. Please use Delete a shift instead.

This operation deletes a shift using the shift's unique ID.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Shift ID
shiftId True string

The unique ID of the shift.

Shifts: Delete an open shift [DEPRECATED]

This action has been deprecated. Please use Delete an open shift instead.

This operation deletes an open shift.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Open Shift ID
openShiftId True string

The unique ID of the open shift.

Shifts: Get a schedule's details [DEPRECATED]

This action has been deprecated. Please use Get a schedule's details instead.

This operation returns details of a schedule using the schedule's unique ID.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Returns

Schedule Entity

Shifts: Get a scheduling group [DEPRECATED]

This action has been deprecated. Please use Get a scheduling group instead.

This operation returns details for a scheduling group using its unique ID.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Scheduling Group ID
schedulingGroupId True string

The unique ID of the Scheduling Group.

Returns

Scheduling Group Entity

Scheduling Group
SchedulingGroupResponse

Shifts: Get a shift [DEPRECATED]

This action has been deprecated. Please use Get a shift instead.

This operation returns details for a shift using the shift's unique ID.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Shift ID
shiftId True string

The unique ID of the shift.

Returns

Shift Entity

Shifts: Get an open shift [DEPRECATED]

This action has been deprecated. Please use Get an open shift instead.

This operation returns details for an open shift.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Open Shift ID
openShiftId True string

The unique ID of the open shift.

Returns

Open Shift Entity

Open Shift
OpenShiftResponse

Shifts: List all Offer Shift requests [DEPRECATED]

This action has been deprecated. Please use List all Offer Shift requests instead.

This operation returns all offer shift requests in a schedule

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Top Count
$top integer

Total number of requests to retrieve

Request State
state string

Request state filter

Returns

Name Path Type Description
Offer Shift Requests List
value array of OfferShiftRequestResponse

List of Offer Shift requests in the schedule

Shifts: List all Open Shift requests [DEPRECATED]

This action has been deprecated. Please use List all Open Shift requests instead.

This operation returns all open shift change requests in a schedule

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Top Count
$top integer

Total number of requests to retrieve

Request State
state string

Request state filter

Returns

Name Path Type Description
Open Shift Change Requests List
value array of OpenShiftChangeRequestResponse

List of Open Shift Change Requests in the schedule

Shifts: List all Open Shifts [DEPRECATED]

This action has been deprecated. Please use List all Open Shifts instead.

This operation returns all open shifts in a team

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

From Start Time
startTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Top Count
$top integer

Total number of open shifts to retrieve

Returns

Name Path Type Description
Open Shifts List
value array of OpenShiftResponse

List of open shifts in the schedule

Shifts: List all scheduling groups [DEPRECATED]

This action has been deprecated. Please use List all scheduling groups instead.

This operation returns all scheduling groups in a schedule

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Top Count
$top integer

Total number of entries to retrieve

Returns

Name Path Type Description
Scheduling Groups List
value array of SchedulingGroupResponse

List of schedule groups in the schedule

Shifts: List all shifts [DEPRECATED]

This action has been deprecated. Please use List all shifts instead.

This operation returns all shifts assigned to members of a team

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

From Start Time
startTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Top Count
$top integer

Total number of shifts to retrieve

Returns

Name Path Type Description
Shifts List
value array of ShiftResponse

List of shifts in the schedule

Shifts: List all Swap Shifts requests [DEPRECATED]

This action has been deprecated. Please use List all Swap Shifts requests instead.

This operation returns all swap shifts requests in a schedule

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Top Count
$top integer

Total number of requests to retrieve

Request State
state string

Request state filter

Returns

Name Path Type Description
Swap Shifts Change Requests List
value array of SwapShiftsChangeRequestResponse

List of Swap Shifts Change Requests in the schedule

Shifts: List all Time Off reasons [DEPRECATED]

This action has been deprecated. Please use List all Time Off reasons instead.

This operation returns the list of time off reasons associated with a team.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Top Count
$top integer

Total number of Time Off reasons to retrieve

Returns

The list of Time Off Reasons.

List of time off reasons associated with a team
GetTimeOffReasonsResponse

Shifts: List all Time Off requests [DEPRECATED]

This action has been deprecated. Please use List all Time Off requests instead.

This operation returns all time off requests in a schedule

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Top Count
$top integer

Total number of requests to retrieve

Request State
state string

Request state filter

Returns

Name Path Type Description
TimeOff Requests List
value array of TimeOffRequestResponse

List of Time Off requests in the schedule

Shifts: Update an Open Shift [DEPRECATED]

This action has been deprecated. Please use Update an Open Shift instead.

Update an open shift in a schedule.

Parameters

Name Key Required Type Description
Team
teamId True string

Add Team ID

Open Shift ID
openShiftId True string

The unique ID of the open shift.

Scheduling Group ID
schedulingGroupId string

Scheduling Group ID

Display Name
displayName string

Display Name

Notes
notes string

Notes

From Start Time
startDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Theme
theme string

Theme

Open Slot Count
openSlotCount True integer

Open Slot Count

Is Paid
isPaid boolean

Is Paid

From Start Time
startDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime True date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Code
code string

Code

Display Name
displayName string

Display Name

Returns

Open Shift Entity

Open Shift
OpenShiftResponse

Triggers

For a selected message

This trigger allows you to start a flow for a selected message in Microsoft Teams. (Available only for Power Automate.)

When a new channel message is added

This operation triggers when a new message is posted to a channel in a Team. Note that this trigger only fires when a root messages is added in the channel. Replies to an existing channel message will not result in the trigger event firing.

When a new team member is added

This operation triggers when a member is added to the given team.

When I am mentioned in a channel message

This operation triggers when a new message is added to a channel in a Team, that mentions the current user.

For a selected message

This trigger allows you to start a flow for a selected message in Microsoft Teams. (Available only for Power Automate.)

Returns

The outputs of this operation are dynamic.

When a new channel message is added

This operation triggers when a new message is posted to a channel in a Team. Note that this trigger only fires when a root messages is added in the channel. Replies to an existing channel message will not result in the trigger event firing.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Returns

Name Path Type Description
attachments
attachments array of object

attachments

items
attachments object
content
body.content string

content

contentType
body.contentType string

contentType

createdDateTime
createdDateTime date-time

createdDateTime

deleted
deleted boolean

deleted

etag
etag string

etag

application
from.application object

application

device
from.device string

device

displayName
from.user.displayName string

displayName

id
from.user.id string

ID

identityProvider
from.user.identityProvider string

identityProvider

id
id string

Unique ID of the message.

importance
importance string

importance

lastModifiedDateTime
lastModifiedDateTime string

lastModifiedDateTime

locale
locale string

locale

mentions
mentions array of object

mentions

items
mentions object
messageType
messageType string

messageType

reactions
reactions array of object

reactions

items
reactions object
replyToId
replyToId string

ID of the parent message of the thread

subject
subject string

Message subject line. Optional.

summary
summary string

Summary text of the message that could be used for push notifications and summary views or fall back views.

When a new team member is added

This operation triggers when a member is added to the given team.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Returns

Name Path Type Description
User Id
id string

Unique id of the user.

When I am mentioned in a channel message

This operation triggers when a new message is added to a channel in a Team, that mentions the current user.

Parameters

Name Key Required Type Description
Team
groupId True string

Add Team ID

Channel
channelId True string

Add Teams channel ID

Returns

Name Path Type Description
attachments
attachments array of object

attachments

items
attachments object
content
body.content string

content

contentType
body.contentType string

contentType

createdDateTime
createdDateTime date-time

createdDateTime

deleted
deleted boolean

deleted

etag
etag string

etag

application
from.application object

application

device
from.device string

device

displayName
from.user.displayName string

displayName

id
from.user.id string

ID

identityProvider
from.user.identityProvider string

identityProvider

id
id string

Unique ID of the message.

importance
importance string

importance

lastModifiedDateTime
lastModifiedDateTime string

lastModifiedDateTime

locale
locale string

locale

mentions
mentions array of object

mentions

items
mentions object
messageType
messageType string

messageType

reactions
reactions array of object

reactions

items
reactions object
replyToId
replyToId string

ID of the parent message of the thread

subject
subject string

Message subject line. Optional.

summary
summary string

Summary text of the message that could be used for push notifications and summary views or fall back views.

Definitions

MessageId

Name Path Type Description
Message Id
id string

Unique Message Id

GetMessagesFromChannel_Response

Name Path Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

@odata.nextLink
@odata.nextLink string

@odata.nextLink

Message List
value OnNewChannelMessage_Response

List of one or more messages for a specific channel in a Team.

OnNewChannelMessage_Response

List of one or more messages for a specific channel in a Team.

Name Path Type Description
attachments
attachments array of object

attachments

items
attachments object
content
body.content string

content

contentType
body.contentType string

contentType

createdDateTime
createdDateTime date-time

createdDateTime

deleted
deleted boolean

deleted

etag
etag string

etag

application
from.application object

application

device
from.device string

device

displayName
from.user.displayName string

displayName

id
from.user.id string

ID

identityProvider
from.user.identityProvider string

identityProvider

id
id string

Unique ID of the message.

importance
importance string

importance

lastModifiedDateTime
lastModifiedDateTime string

lastModifiedDateTime

locale
locale string

locale

mentions
mentions array of object

mentions

items
mentions object
messageType
messageType string

messageType

reactions
reactions array of object

reactions

items
reactions object
replyToId
replyToId string

ID of the parent message of the thread

subject
subject string

Message subject line. Optional.

summary
summary string

Summary text of the message that could be used for push notifications and summary views or fall back views.

GetTeamResponse

Get team response

Name Path Type Description
Team ID
id string

The unique ID of the team.

Display Name
displayName string

The name of the team.

Description of team
description string

The description of the Team.

Internal Id
internalId string

The Internal Id of the Team.

Web Url of team
webUrl string

The Web Url of the Team.

Is Archived
isArchived boolean

Is Archived

memberSettings
memberSettings MemberSettings

Member Settings Entity

guestSettings
guestSettings GuestSettings

Guest Settings Entity

messagingSettings
messagingSettings MessagingSettings

Messaging Settings Entity

funSettings
funSettings FunSettings

Guest Settings Entity

discoverySettings
discoverySettings DiscoverySettings

Guest Settings Entity

GetTimeOffReasonsResponse

The list of Time Off Reasons.

Name Path Type Description
Array containing time off reasons
value array of object

The list of time off reasons.

Time Off Reason ID
value.id string

The unique ID of the time off reason.

Created Time
value.createdDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Modified Date Time
value.lastModifiedDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Display Name
value.displayName string

Display Name

Icon Type
value.iconType string

Icon Type

Is Active
value.isActive boolean

Is Active

Last Modified By
value.lastModifiedBy LastModifiedBy

Last Modified By

TimeOffRequestResponse

TimeOff Request Entity

Name Path Type Description
ID
id string

The unique ID of the TimeOff request.

Created Time
createdDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Modified Time
lastModifiedDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Assigned To
assignedTo string

The person the request is assigned to: 'manager' or 'recipient'

State
state string

'approved', 'pending' or 'declined'

Sender Time
senderDateTime date-time

Time when the request was sent

Sender Message
senderMessage string

The message from the request sender

Sender ID
senderUserId string

The ID of the user that sent the request

Manager Action Time
managerActionDateTime date-time

Time when the manager responded

Manager Message
managerActionMessage string

The message from the manager

Manager ID
managerUserId string

The ID of the manager that responded

From Start Time
startDateTime date-time

Start of time requested off

To End Time
endDateTime date-time

End of time requested off

TimeOff Reason ID
timeOffReasonId string

The ID of the TimeOff Reason

OfferShiftRequestResponse

Offer Shift Request Entity

Name Path Type Description
ID
id string

The unique ID of the Offer Shift request.

Created Time
createdDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Modified Time
lastModifiedDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Assigned To
assignedTo string

The person the request is assigned to: 'manager' or 'recipient'

State
state string

'approved', 'pending' or 'declined'

Sender Time
senderDateTime date-time

Time when the request was sent

Sender Message
senderMessage string

The message from the request sender

Sender ID
senderUserId string

The ID of the user that sent the request

Sender Shift ID
senderShiftId string

The ID of the shift from the sender

Receiver Time
recipientActionDateTime date-time

Time when the recipient responded

Recipient Message
recipientActionMessage string

The message from the recipient

Recipient ID
recipientUserId string

The ID of the recipient of the request

Manager Action Time
managerActionDateTime date-time

Time when the manager responded

Manager Message
managerActionMessage string

The message from the manager

Manager ID
managerUserId string

The ID of the manager that responded

SwapShiftsChangeRequestResponse

Swap Shift Request Entity

Name Path Type Description
ID
id string

The unique ID of the Swap Shift request.

Created Time
createdDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Modified Time
lastModifiedDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Assigned To
assignedTo string

The person the request is assigned to: 'manager' or 'recipient'

State
state string

'approved', 'pending' or 'declined'

Sender Time
senderDateTime date-time

Time when the request was sent

Sender Message
senderMessage string

The message from the request sender

Sender ID
senderUserId string

The ID of the user that sent the request

Sender Shift ID
senderShiftId string

The ID of the shift from the sender

Receiver Time
recipientActionDateTime date-time

Time when the recipient responded

Recipient Message
recipientActionMessage string

The message from the recipient

Recipient ID
recipientUserId string

The ID of the recipient of the request

Recipient Shift ID
recipientShiftId string

The ID of the shift from the recipient

Manager Action Time
managerActionDateTime date-time

Time when the manager responded

Manager Message
managerActionMessage string

The message from the manager

Manager ID
managerUserId string

The ID of the manager that responded

OpenShiftChangeRequestResponse

Open Shift Change Request Entity

Name Path Type Description
ID
id string

The unique ID of the Open Shift Change request.

Created Time
createdDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Modified Time
lastModifiedDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Assigned To
assignedTo string

The person the request is assigned to: 'manager' or 'recipient'

State
state string

'approved', 'pending' or 'declined'

Sender Time
senderDateTime date-time

Time when the request was sent

Sender Message
senderMessage string

The message from the request sender

Sender ID
senderUserId string

The ID of the user that sent the request

Manager Action Time
managerActionDateTime date-time

Time when the manager responded

Manager Message
managerActionMessage string

The message from the manager

Manager ID
managerUserId string

The ID of the manager that responded

Open Shift ID
openShiftId string

The ID of the open shift being requested

OpenShiftResponse

Open Shift Entity

Name Path Type Description
ID
id string

The unique ID of the open shift.

Created Date Time
createdDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Modified Date Time
lastModifiedDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Scheduling Group ID
schedulingGroupId string

Scheduling Group ID

Last Modified By
lastModifiedBy LastModifiedBy

Last Modified By

Shared Open Shift
sharedOpenShift SharedOpenShift

Shared version of the open shift

Draft Open Shift
draftOpenShift DraftOpenShift

Preliminary version of the open shift

SharedOpenShift

Shared version of the open shift

Name Path Type Description
Display Name
displayName string

Display Name

Notes
notes string

Notes

From Start Time
startDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Theme
theme string

Theme

Open Slot Count
openSlotCount integer

Open Slot Count

activities
activities Activities

Shift activities

DraftOpenShift

Preliminary version of the open shift

Name Path Type Description
Display Name
displayName string

Display Name

Notes
notes string

Notes

From Start Time
startDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Theme
theme string

Theme

Open Slot Count
openSlotCount integer

Open Slot Count

activities
activities Activities

Shift activities

ShiftResponse

Shift Entity

Name Path Type Description
ID
id string

The unique ID of the shift.

Created Date Time
createdDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Modified Date Time
lastModifiedDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Assigned To User ID
userId string

Assigned To User ID

Scheduling Group ID
schedulingGroupId string

Scheduling Group ID

Last Modified By
lastModifiedBy LastModifiedBy

Last Modified By

Shared Shift
sharedShift SharedShift

Shared version of the shift

Draft Shift
draftShift DraftShift

Preliminary version of the shift

SharedShift

Shared version of the shift

Name Path Type Description
Display Name
displayName string

Display Name

Notes
notes string

Notes

From Start Time
startDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Theme
theme string

Theme

activities
activities Activities

Shift activities

DraftShift

Preliminary version of the shift

Name Path Type Description
Display Name
displayName string

Display Name

Notes
notes string

Notes

From Start Time
startDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Theme
theme string

Theme

activities
activities Activities

Shift activities

ScheduleResponse

Schedule Entity

Name Path Type Description
Schedule ID
id string

The unique ID of the schedule.

Schedule Time Zone
timeZone string

The Time Zone of the schedule.

Schedule Provision Status
provisionStatus string

The Provision Status of the schedule.

Schedule Provision Status Code
provisionStatusCode string

The Provision Status Code of the schedule.

Activities

Shift activities

Name Path Type Description
Is Paid
isPaid boolean

Is Paid

From Start Time
startDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

To End Time
endDateTime date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Code
code string

Code

Display Name
displayName string

Display Name

SchedulingGroupResponse

Scheduling Group Entity

Name Path Type Description
ID
id string

The unique ID of the scheduling group.

Display Name
displayName string

The display name for the scheduling group.

Is Active
isActive boolean

Indicates whether the scheduling group can be used when creating new entities or updating existing ones.

User IDs
userIds array of string

List of IDs of users in the scheduling group.

AtMentionUser_V1

@mention Token

Name Path Type Description
@mention
atMention string

An @mention token for the user. This property can be inserted into messages and adaptive cards.

LastModifiedBy

Last Modified By

Name Path Type Description
Application
application string

Application

Device
device string

Device

Conversation
conversation string

Conversation

Id
user.id string

Id

Display Name
user.displayName string

Display Name

MemberSettings

Member Settings Entity

Name Path Type Description
Allow Create Update Channels
allowCreateUpdateChannels boolean

Allow to create and update channels

Allow Delete Channels
allowDeleteChannels boolean

Allow to delete channels

Allow Add Remove Apps
allowAddRemoveApps boolean

Allow to add and remove apps

Allow Create Update Remove Tabs
allowCreateUpdateRemoveTabs boolean

Allow to create, update and remove tabs

Allow Create Update Remove Connectors
allowCreateUpdateRemoveConnectors boolean

Allow to create, update and remove connectors

GuestSettings

Guest Settings Entity

Name Path Type Description
Allow Create Update Channels
allowCreateUpdateChannels boolean

Allow to create and update channels

Allow Delete Channels
allowDeleteChannels boolean

Allow to delete channels

MessagingSettings

Messaging Settings Entity

Name Path Type Description
Allow User Edit Messages
allowUserEditMessages boolean

Allow User Edit Messages

Allow User Delete Messages
allowUserDeleteMessages boolean

Allow User Delete Messages

Allow Owner Delete Messages
allowOwnerDeleteMessages boolean

Allow Owner Delete Messages

Allow Team Mentions
allowTeamMentions boolean

Allow Team Mentions

Allow Channel Mentions
allowChannelMentions boolean

Allow Channel Mentions

FunSettings

Guest Settings Entity

Name Path Type Description
Allow Giphy
allowGiphy boolean

Allow Giphy

Giphy Content Rating
giphyContentRating string

Giphy Content Rating

Allow Stickers And Memes
allowStickersAndMemes boolean

Allow Stickers And Memes

Allow Custom Memes
allowCustomMemes boolean

Allow Custom Memes

DiscoverySettings

Guest Settings Entity

Name Path Type Description
Show In Teams Search And Suggestions
showInTeamsSearchAndSuggestions boolean

Show In Teams Search And Suggestions