Update term

Namespace: microsoft.graph.termStore

Update the properties of a term object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	TermStore.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

PATCH /sites/{site-id}/termStore/sets/{set-id}/terms/{term-id}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

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

The following table shows the properties that can be updated for a term object.

Property	Type	Description
labels	microsoft.graph.termStore.localizedLabel collection	Labels of a term.
descriptions	microsoft.graph.termStore.localizedDescription collection	Description about the term.
properties	microsoft.graph.keyValue collection	Properties associated with the term.

Response

If successful, this method returns a 200 OK response code and an updated microsoft.graph.termStore.term object in the response body.

Examples

Request

HTTP

PATCH https://graph.microsoft.com/v1.0/sites/microsoft.sharepoint.com,b9b0bc03-cbc4-40d2-aba9-2c9dd9821ddf,6a742cee-9216-4db5-8046-13a595684e74/termStore/sets/6362a3a4-c24c-4ce7-b491-e32c8a087071/terms/81be9856-9856-81be-5698-be815698be81
Content-Type: application/json

{
  "labels" : [
      {
          "name" : "changedLabel",
          "languageTag" : "en-US",
          "isDefault" : true
      }
  ]
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models.TermStore;

var requestBody = new Term
{
	Labels = new List<LocalizedLabel>
	{
		new LocalizedLabel
		{
			Name = "changedLabel",
			LanguageTag = "en-US",
			IsDefault = true,
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Sites["{site-id}"].TermStore.Sets["{set-id}"].Terms["{term-id}"].PatchAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc sites term-store sets terms patch --site-id {site-id} --set-id {set-id} --term-id {term-id} --body '{\
  "labels" : [\
      {\
          "name" : "changedLabel",\
          "languageTag" : "en-US",\
          "isDefault" : true\
      }\
  ]\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodelstermstore "github.com/microsoftgraph/msgraph-sdk-go/models/termstore"
	  //other-imports
)

requestBody := graphmodelstermstore.NewTerm()


localizedLabel := graphmodelstermstore.NewLocalizedLabel()
name := "changedLabel"
localizedLabel.SetName(&name) 
languageTag := "en-US"
localizedLabel.SetLanguageTag(&languageTag) 
isDefault := true
localizedLabel.SetIsDefault(&isDefault) 

labels := []graphmodelstermstore.LocalizedLabelable {
	localizedLabel,
}
requestBody.SetLabels(labels)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
terms, err := graphClient.Sites().BySiteId("site-id").TermStore().Sets().BySetId("set-id").Terms().ByTermId("term-id").Patch(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.termstore.Term term = new com.microsoft.graph.models.termstore.Term();
LinkedList<com.microsoft.graph.models.termstore.LocalizedLabel> labels = new LinkedList<com.microsoft.graph.models.termstore.LocalizedLabel>();
com.microsoft.graph.models.termstore.LocalizedLabel localizedLabel = new com.microsoft.graph.models.termstore.LocalizedLabel();
localizedLabel.setName("changedLabel");
localizedLabel.setLanguageTag("en-US");
localizedLabel.setIsDefault(true);
labels.add(localizedLabel);
term.setLabels(labels);
com.microsoft.graph.models.termstore.Term result = graphClient.sites().bySiteId("{site-id}").termStore().sets().bySetId("{set-id}").terms().byTermId("{term-id}").patch(term);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const term = {
  labels: [
      {
          name: 'changedLabel',
          languageTag: 'en-US',
          isDefault: true
      }
  ]
};

await client.api('/sites/microsoft.sharepoint.com,b9b0bc03-cbc4-40d2-aba9-2c9dd9821ddf,6a742cee-9216-4db5-8046-13a595684e74/termStore/sets/6362a3a4-c24c-4ce7-b491-e32c8a087071/terms/81be9856-9856-81be-5698-be815698be81')
	.update(term);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\TermStore\Term;
use Microsoft\Graph\Generated\Models\TermStore\LocalizedLabel;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Term();
$labelsLocalizedLabel1 = new LocalizedLabel();
$labelsLocalizedLabel1->setName('changedLabel');
$labelsLocalizedLabel1->setLanguageTag('en-US');
$labelsLocalizedLabel1->setIsDefault(true);
$labelsArray []= $labelsLocalizedLabel1;
$requestBody->setLabels($labelsArray);


$result = $graphServiceClient->sites()->bySiteId('site-id')->termStore()->sets()->bySetId('set-id')->terms()->byTermId('term-id')->patch($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Sites

$params = @{
	labels = @(
		@{
			name = "changedLabel"
			languageTag = "en-US"
			isDefault = $true
		}
	)
}

Update-MgSiteTermStoreSetTerm -SiteId $siteId -SetId $setId -TermId $termId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.term_store.term import Term
from msgraph.generated.models.term_store.localized_label import LocalizedLabel
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Term(
	labels = [
		LocalizedLabel(
			name = "changedLabel",
			language_tag = "en-US",
			is_default = True,
		),
	],
)

result = await graph_client.sites.by_site_id('site-id').term_store.sets.by_set_id('set-id').terms.by_term_id('term-id').patch(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "81be9856-9856-81be-5698-be815698be81",
  "labels" : [
      {
          "name" : "changedLabel",
          "languageTag" : "en-US",
          "isDefault" : true
      }
  ]
}