Skip to main content
A tag is a label you attach to articles. For fields and response details, see the API reference.

List tags

This command lists tags with the number of articles that use each one. Use this to find a tag ID before you update, delete, or merge it.
--sort-by takes name or articles_count. --order-by takes asc or desc. It defaults to asc for name and desc for articles_count.

Create a tag

This command creates a tag. Tag names are unique in the workspace, ignoring case. Creating a tag needs the Manage tags permission.
--style takes primary, secondary, info, success, warning or danger. It defaults to secondary.

Update a tag

This command changes the name, description or style of a tag. Only the flags you pass change.
Required arguments:
  • <id> - Tag ID from tags list

Delete a tag

This command deletes a tag and removes it from every article. The articles are kept.
Required arguments:
  • <id> - Tag ID from tags list

Merge tags

This command merges tags into one. Articles that carry a secondary tag get the primary tag. The secondary tags are then deleted. Use this to clean up near-duplicate tags.
If any tag is unknown, nothing is merged. The primary tag cannot be in --secondary-ids.