teamworkTag resource type

Namespace: microsoft.graph

Represents a tag associated with a team.

Tags provide a flexible way for customers to classify users or groups based on a common attribute within a team. For example, a Nurse, Manager, or Designer tag will enable users to reach groups of people in Teams without having to type every single name.

When a tag is added, users can @mention it in a channel. Everyone who has been assigned that tag receives a notification just as they would if they were @mentioned individually. Users can also use a tag to start a new chat with the members of that tag.

Inherits from entity.

Methods

Method	Return type	Description
List teamworkTags	teamworkTag collection	Get a list of the tag objects and their properties.
Create teamworkTag	teamworkTag	Create a standard tag for members in a team.
Get teamworkTag	teamworkTag	Read the properties and relationships of a tag object.
Update teamworkTag	teamworkTag	Update the properties of a tag object.
Delete teamworkTag	None	Delete a tag object permanently.

Properties

Property	Type	Description
description	String	The description of the tag as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.
displayName	String	The name of the tag as it appears to the user in Microsoft Teams.
id	String	The unique identifier for the tag. Inherited from entity.
memberCount	Int32	The number of users assigned to the tag.
tagType	teamworkTagType	The type of the tag. Default is standard.
teamId	String	ID of the team in which the tag is defined.

teamworkTagType values

Member	Description
standard	Default type for a tag. Tags of type standard can be managed in the team by members who have permissions.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.
scheduled	Shift-based tag created and managed from the Shifts app.

Relationships

Relationship	Type	Description
members	teamworkTagMember collection	Users assigned to the tag.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.teamworkTag",
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "memberCount": "Int32",
  "tagType": "String",
  "teamId": "String"
}

Related content

• teamworkTagMember