Create teamworkTag

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a standard tag for members in the team.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from most to least privileged)
Delegated (work or school account)	TeamworkTag.ReadWrite
Delegated (personal Microsoft account)	Not supported.
Application	TeamworkTag.ReadWrite.All

HTTP request

POST /teams/{team-Id}/tags

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the teamworkTag object.

The following table shows the properties that are required when you create the teamworkTag.

Property	Type	Description
displayName	String	Name of the tag. The value can't be more than 40 characters.
members	teamworkTagMember collection	Members of the team to add to the tag. Set the user identifier property of each member. Members count shouldn't be more than 25.

Response

If successful, this method returns a 201 Created response code and a teamworkTag object in the response body.

Examples

Request

HTTP

POST https://graph.microsoft.com/beta/teams/53c53217-fe77-4383-bc5a-ed4937a1aecd/tags
Content-Type: application/json

{
  "displayName": "Finance",
  "members":[
	{
		"userId":"92f6952f-61ca-4a94-8910-508a240bc167"
	},
	{
		"userId":"085d800c-b86b-4bfc-a857-9371ad1caf29"
	}
  ]
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var teamworkTag = new TeamworkTag
{
	DisplayName = "Finance",
	Members = new TeamworkTagMembersCollectionPage()
	{
		new TeamworkTagMember
		{
			UserId = "92f6952f-61ca-4a94-8910-508a240bc167"
		},
		new TeamworkTagMember
		{
			UserId = "085d800c-b86b-4bfc-a857-9371ad1caf29"
		}
	}
};

await graphClient.Teams["{team-id}"].Tags
	.Request()
	.AddAsync(teamworkTag);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const teamworkTag = {
  displayName: 'Finance',
  members: [
	{
		userId: '92f6952f-61ca-4a94-8910-508a240bc167'
	},
	{
		userId: '085d800c-b86b-4bfc-a857-9371ad1caf29'
	}
  ]
};

await client.api('/teams/53c53217-fe77-4383-bc5a-ed4937a1aecd/tags')
	.version('beta')
	.post(teamworkTag);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/teams/53c53217-fe77-4383-bc5a-ed4937a1aecd/tags"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphTeamworkTag *teamworkTag = [[MSGraphTeamworkTag alloc] init];
[teamworkTag setDisplayName:@"Finance"];
NSMutableArray *membersList = [[NSMutableArray alloc] init];
MSGraphTeamworkTagMember *members = [[MSGraphTeamworkTagMember alloc] init];
[members setUserId:@"92f6952f-61ca-4a94-8910-508a240bc167"];
[membersList addObject: members];
MSGraphTeamworkTagMember *members = [[MSGraphTeamworkTagMember alloc] init];
[members setUserId:@"085d800c-b86b-4bfc-a857-9371ad1caf29"];
[membersList addObject: members];
[teamworkTag setMembers:membersList];

NSError *error;
NSData *teamworkTagData = [teamworkTag getSerializedDataWithError:&error];
[urlRequest setHTTPBody:teamworkTagData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
	completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

		//Request Completed

}];

[meDataTask execute];

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

TeamworkTag teamworkTag = new TeamworkTag();
teamworkTag.displayName = "Finance";
LinkedList<TeamworkTagMember> membersList = new LinkedList<TeamworkTagMember>();
TeamworkTagMember members = new TeamworkTagMember();
members.userId = "92f6952f-61ca-4a94-8910-508a240bc167";
membersList.add(members);
TeamworkTagMember members1 = new TeamworkTagMember();
members1.userId = "085d800c-b86b-4bfc-a857-9371ad1caf29";
membersList.add(members1);
TeamworkTagMemberCollectionResponse teamworkTagMemberCollectionResponse = new TeamworkTagMemberCollectionResponse();
teamworkTagMemberCollectionResponse.value = membersList;
TeamworkTagMemberCollectionPage teamworkTagMemberCollectionPage = new TeamworkTagMemberCollectionPage(teamworkTagMemberCollectionResponse, null);
teamworkTag.members = teamworkTagMemberCollectionPage;

graphClient.teams("53c53217-fe77-4383-bc5a-ed4937a1aecd").tags()
	.buildRequest()
	.post(teamworkTag);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewTeamworkTag()
displayName := "Finance"
requestBody.SetDisplayName(&displayName)
requestBody.SetMembers( []TeamworkTagMember {
	msgraphsdk.NewTeamworkTagMember(),
	SetAdditionalData(map[string]interface{}{
		"userId": "92f6952f-61ca-4a94-8910-508a240bc167",
	}
	msgraphsdk.NewTeamworkTagMember(),
	SetAdditionalData(map[string]interface{}{
		"userId": "085d800c-b86b-4bfc-a857-9371ad1caf29",
	}
}
teamId := "team-id"
result, err := graphClient.TeamsById(&teamId).Tags().Post(requestBody)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.

PowerShell

Import-Module Microsoft.Graph.Teams

$params = @{
	DisplayName = "Finance"
	Members = @(
		@{
			UserId = "92f6952f-61ca-4a94-8910-508a240bc167"
		}
		@{
			UserId = "085d800c-b86b-4bfc-a857-9371ad1caf29"
		}
	)
}

New-MgTeamTag -TeamId $teamId -BodyParameter $params

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.teamworkTag",
  "id": "MjQzMmI1N2ItMGFiZC00M2RiLWFhN2ItMTZlYWRkMTE1ZDM0IyM3ZDg4M2Q4Yi1hMTc5LTRkZDctOTNiMy1hOGQzZGUxYTIxMmUjI3RhY29VSjN2RGk==",
  "teamId": "53c53217-fe77-4383-bc5a-ed4937a1aecd",
  "displayName": "Financee",
  "memberCount": 2,
  "tagType": "standard"
}