Get Tags by ID

Categories give each article a place in the help center's tree. Tags cut across that tree: one tag can link articles from many categories, and the help center can list every article with a tag on a tag page. A tag is only a name, and articles refer to it by ID.

Names

name is 1 to 64 characters and must be unique in the org, ignoring case. Kustomer rejects "Billing" if "billing" already exists. Because articles store tag IDs, renaming a tag with PATCH updates it on every article at once. This reference has no endpoint for deleting a tag. To find tags, filter the list with name, which matches the start of the name and ignores case, so name=ret finds "Returns" and "Retail".

Tagging articles

Send tag IDs, not names, in tags. Each article version has its own tags, so tags you set on a draft go live when you publish it. Set them with PUT /v1/kb/articles/{id}/versions/{lang}/draft, or send them when you create the article or a version. The article also has a tags list, which PUT /v1/kb/articles/{id} sets. If any ID doesn't match an existing tag, Kustomer rejects the draft update. Create tags first, then attach them.

Which endpoint to use

To tag articles, use the article version endpoints. Reads need a knowledge base read role, and writes need org.admin.kb.write or the matching permission.