Skip to main content

Update a tag group

Log in to add to favourites

Update an existing tag group

Call signature

TypeScript
update(tagGroup: IUpdateTagGroup): Promise<TagGroup>;

Parameters

NameTypeDescription
tagGroupIUpdateTagGroupA 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

Update an existing tag group

TypeScript
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}`);

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request