Skip to content

Document Knowledge Hub content-tagging endpoints (Preview)#556

Merged
kilian-tennyson merged 3 commits into
mainfrom
kiliantennyson/parthas/content-tagging-docs
Jun 19, 2026
Merged

Document Knowledge Hub content-tagging endpoints (Preview)#556
kilian-tennyson merged 3 commits into
mainfrom
kiliantennyson/parthas/content-tagging-docs

Conversation

@kilian-tennyson

Copy link
Copy Markdown
Contributor

Why?

External developers need a published contract to apply and remove tags on Knowledge Hub content through the public API. Until these endpoints are in the spec they're undiscoverable, unsupported, and excluded from generated SDKs.

How?

Adds Preview-level paths and schemas for applying/removing tags on articles, KB snippets, and internal articles, plus the tags field on the internal-article read response. Mirrors the existing Preview/versioned endpoint conventions in the spec.

Generated with Claude Code

Add the four public v3 content-tagging endpoints to the Preview spec
(descriptions/0/api.intercom.io.yaml):

  POST   /articles/{article_id}/tags
  DELETE /articles/{article_id}/tags/{id}
  POST   /content_snippets/{content_snippet_id}/tags
  DELETE /content_snippets/{content_snippet_id}/tags/{id}

These document the implementation shipped in intercom/intercom#523830
(apply/remove an existing tag on articles + KB content snippets). The
endpoints are Preview-gated via the intercom_version_preview header,
reuse the existing tag/error schemas and the Unauthorized response, and
document the read_write_articles_scope / read_write_content_snippets
OAuth scopes plus the 403 (forbidden) and 404 (article/snippet/tag not
found) responses.

Companion to intercom/intercom#523830.
Fold the internal-article tag support shipped in intercom/intercom#524047
into the content-tagging docs:

  POST   /internal_articles/{internal_article_id}/tags
  DELETE /internal_articles/{internal_article_id}/tags/{id}

Plus a version-gated 'tags' field added to the internal-article read
responses (GET /internal_articles and GET /internal_articles/{id}) via a
$ref to the shared 'tags' schema on internal_article_list_item, mirroring
public articles.

Write endpoints mirror the articles/content-snippets shape exactly: same
{id} body + optional admin_id, same AddContentTaggingApi Preview gate,
same VersionedTaggingPresenter response, same 403/404 errors (with an
internal_article_not_found case). Internal-article tags ride the
read_write_articles_scope OAuth scope (same as public articles), not a
separate scope.

Companion to intercom/intercom#524047 (and #523830 for articles + KB
snippets).
Keep byte-identical with the developer-docs companion: extend the tag
schema's applied_at/applied_by descriptions to include articles, internal
articles, and content snippets returned by the content-tagging endpoints.
@kilian-tennyson kilian-tennyson merged commit ca7ea45 into main Jun 19, 2026
3 checks passed
@kilian-tennyson kilian-tennyson deleted the kiliantennyson/parthas/content-tagging-docs branch June 19, 2026 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants