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:
- List topic conversations
GET /topics/:topic_id/conversationsupdated to List link conversations
- List topics
GET /topicsupdated to List links
- Create topic
POST /topicsupdated to Create link
- Get topic
GET /topics/:topic_idupdated to Get link
- Update a topic
PATCH /topics/:topic_idupdated to Update link
- Add conversation topics
POST /conversations/:conversation_id/topicsupdated to Add conversation links
- Remove conversation topics
DELETE /conversations/:conversation_id/topicsupdated to Remove conversation links
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 to [email protected] with any questions or concerns.