Update a tag group
Log in to add to favouritesPage last updated 02 July 2025
Update an existing tag group
Call signature
update(tagGroup: IUpdateTagGroup): Promise<TagGroup>;Parameters
| Name | Type | Description |
|---|---|---|
| tagGroup | IUpdateTagGroup | A tag group-like object containing the required fields to update a tag group (id, name and an optional description) |
Returns
A Promise that will resolve with the updated Tag Group
Remarks
Throws any error that is returned by the API for any unsuccessful request echoing the HTTP status returned from the API
Example
const tagGroup = await client.tags.groups.update({
id: "topics",
name: "Topics / themes",
description: "A collection of topic / theme tags"
});
console.log(`Successfully updated tag group to version ${tagGroup.version.versionNo}`);