Topic

Users with the Edit Topics or Modify All Data permission can edit topic names and descriptions. Users with the Delete Topics or Modify All Data permission can merge and delete topics.

Resource

1/connect/topics/topicId

1/connect/communities/communityId/topics/topicId

Available since version

29.0

In version 28.0, use /chatter/topics/topicId.

Requires Chatter

No

HTTP methods

GET, PATCH, DELETE, and HEAD

Request body for PATCH

Root XML tag

<topic>

JSON example

1{
2"description":"World Wide Web Consortium (W3C) is the main international standards organization for the web.",
3"name":"W3C"
4}

Properties

Name	Type	Description	Available Version
description	String	Text description of the topic	28.0
idsToMerge	String[]	List of up to five secondary topic IDs to merge with the primary topic If any of these secondary topics are managed topics, they lose their topic type, topic images, and children topics. Their feed items are reassigned to the primary topic.	33.0
name	String	Name of the topic Use this property to change only the capitalization and spacing of the topic name.	28.0

Request parameters for PATCH

Parameter Name	Type	Description	Available Since
description	String	Text description of the topic	28.0
idsToMerge	String[]	List of up to five secondary topic IDs to merge with the primary topic If any of these secondary topics are managed topics, they lose their topic type, topic images, and children topics. Their feed items are reassigned to the primary topic.	33.0
name	String	Name of the topic Use this property to change only the capitalization and spacing of the topic name.	28.0

Response body for GET, HEAD, or PATCH

Topic

Response body for DELETE

204: Successful Delete

Topic deletion is asynchronous. If a topic is requested before the deletion completes, the response is 200: Successful and the isBeingDeleted property of the Topic output is true in version 33.0 and later. If a topic is requested after the deletion completes, the response is 404: Not found.

Example for PATCH

This example uses request parameters to update the description of a topic:

1/connect/topics/0TOD000000006RxOAI?description=Edit+requests

This example uses a JSON request body to make the same request:

1/connect/topics/0TOD000000006RxOAI
2
3{
4   "description" : "Edit requests"
5}