GuidesAPI ReferenceChangelogCommunity
Changelog
Front
These docs are for v0.1.0. Click to read the latest docs for v1.0.0.
Back to All
deprecated

[Core API] Topics renamed to Links

over 3 years ago by Henry Dornier

In order to avoid confusion between the API documentation and the user-facing feature, we are renaming Topics-related endpoints to "Links". This new naming clarifies the use case of the feature, and is more consistent with our in-app naming. No underlying functionality or resource IDs will change, but the the legacy Topics routes are now deprecated and will be removed October 31st, 2021. If you are currently relying on Topics, you'll need to make some small updates before the removal date as described below:

Endpoint changes

  • List topic conversations GET /topics/:topic_id/conversations updated to List link conversations GET /links/:link_id/conversations
  • List topics GET /topics updated to List links GET /links
  • Create topic POST /topics updated to Create link POST /links
  • Get topic GET /topics/:topic_id updated to Get link GET /links/:link_id
  • Update a topic PATCH /topics/:topic_id updated to Update link PATCH /links/:link_id
  • Add conversation topics POST /conversations/:conversation_id/topics updated to Add conversation links POST /conversations/:conversation_id/links
  • Remove conversation topics DELETE /conversations/:conversation_id/topics updated to Remove conversation links DELETE /conversations/:conversation_id/links

Model changes

Conversations have been updated to include a conversation.links parameter in addition to the existing conversation.topics parameter. The values of each are identical. conversation.topics will be removed October 31st, 2021.

Topics are now referred to as Links, and have an link.external_url parameter, which has the same value as the legacy topic.link value. The legacy .link parameter will be removed October 31st, 2021.

No data migrations should be required by these changes (the IDs for the topic/link resources in the API such as top_123 are not changing) — you'll just want to update the endpoints you are calling (if you are using any of the above) and make sure you are relying on the updated conversation and link model parameters.

Feel free to reach out on the Front Community with any questions or concerns.