How to update a tag in Teams using HTTP PATCH

  • Last update on September 26th, 2024

Workflows are not available in the Essentials solution.

 

In this guide, we'll walk through the steps to update a team tag in Microsoft Teams using the HTTP PATCH action.

Prerequisites

  • App token generation: you need an app token with the necessary permissions to modify a team tag. This token is used to authenticate requests to the Microsoft Graph API.
  • Team ID and Tag ID: get the ID of the Teams group and the tag you intend to modify. These can be found via the Teams Admin Center or through Graph API queries. 

For more information on permissions and token generation, see the Microsoft Graph permissions documentation.

Execution inputs

Prepare the following information, which will be required by the operator executing the Workflow:

  • Team ID: the unique identifier of the team.
  • Tag ID: the unique identifier of the tag within the team.
  • New Tag Name: the desired new name for the tag.

Modifying a team tag

Step 1: Set up the action

Add a new action to your Workflow. Go to the “HTTP Integrations” category and select the “HTTP API PATCH” action.

Step 2: Configure the URL

Set the URL to specifically target the team tag you wish to update. Format it as follows:

 https://graph.microsoft.com/beta/teams/{team-Id}/tags/{teamworkTag-Id}.

Replace {team-Id} and {teamworkTag-Id} with the Team ID and Tag ID you've prepared.

Step 3: Add the secret key

Input the secret key required for Graph API authorization. For further details about the secret key, refer to this Sending a POST request article.

Step 4: Configure the Body

Specify the changes to the tag in the request body. For example, to change the tag's name, you would adjust this section accordingly.

Step 5: Ensure success status code

Activate the “Ensure success status code” feature to guarantee that the action will fail if the response status code signals an error, aiding in troubleshooting.

Executing the Workflow

After setting up the action, save and publish your Workflow. When running it, you'll be prompted to enter the previously defined execution inputs.

Following a successful execution, the targeted team tag will be updated as specified. You can confirm the update within Microsoft Teams or by querying the tag using the Graph API.