Skip to content

Remove the stale top-level ai_topics field from Preview conversations - #738

Merged
yasser-aboelgheit-intercom merged 1 commit into
mainfrom
yasser/preview-ai_topics
Oct 21, 2026
Merged

yasser-aboelgheit-intercom merged 1 commit into
mainfrom
yasser/preview-ai_topics

Conversation

@yasser-aboelgheit-intercom

Copy link
Copy Markdown
Contributor

Why?

The Preview spec says a conversation has a top-level ai_topics field and shows it in 16 response examples, but the API doesn't return it. Preview returns AI topics inside custom_attributes under "AI Topic and Subtopic", which the spec already describes, so readers and the SDKs expect a field that never arrives.

How?

Removes the stale field, its three schemas, which nothing else uses, and the empty example keys from the Preview spec.

Notes for reviewers
  • The developer reference dropped this field from Preview in October. These schemas were added here once, reverted, and then re-added by a later sync, so they shouldn't come back on the next sync.
  • SDKs: the generated AiTopics, AiTopic and AiSubtopic types go away. fern check: 0 errors.
  • 2.17 still has one empty ai_topics key in a response example. That's left for a follow-up.

Generated with Claude Code

Preview returns AI topics inside custom_attributes, not as a separate
top-level field, so drop the stale property, its schemas and the example keys.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

@cathalging cathalging left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approve: Preview's conversation schemas now match what the API returns

The API returns AI topics inside custom_attributes (under "AI Topic and Subtopic"), not as a top-level ai_topics field. Removing the field and its three schemas brings Preview in line with that, and nothing else still points at the removed schemas.

Optional follow-up: 2.17 still has one empty ai_topics: key in the /conversations/{id}/merge response example (descriptions/2.17/api.intercom.io.yaml:16055). Worth removing in the follow-up the description mentions.

SDK note: the Preview SDK loses the AiTopics, AiTopic and AiSubtopic types and the Conversation.aiTopics property. Code that names them won't compile, but the API never filled them in, so no data is lost.

~ Automated via Claude

@yasser-aboelgheit-intercom
yasser-aboelgheit-intercom merged commit 8a43aa0 into main Oct 21, 2026
4 checks passed
@yasser-aboelgheit-intercom
yasser-aboelgheit-intercom deleted the yasser/preview-ai_topics branch October 21, 2026 12:42
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