Topic

Information about the specified topic. Get information about a topic, change the capitalization or spacing of a topic’s name, and update a topic’s description. Users with the “Delete Topics” or “Modify All Data” permission can use this resource to delete topics. Users with the “Edit Topics” permission can edit topic names and descriptions.

Resource

1/connect/topics/topicId

Available since version

29.0

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

HTTP methods

GET, PATCH, DELETE, and HEAD

Request body for PATCH

Root XML tag

<topic>

JSON

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

Properties

Name	Type	Description	Available Version
description	String	Text description of the topic	28.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
name	String	Name of the topic. Use this parameter 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

Example for PATCH

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

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

This is the same request using a JSON request body:

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

This is the response body:

1{
2   "createdDate": "2012-03-22T13:58:30.000Z",
3   "description": "Edit requests",
4   "id": "0TOD000000006RxOAI",
5   "talkingAbout": 1,
6   "name": "edits",
7   "url": "/services/data/v30.0/connect/topics/0TOD000000006RxOAI"
8}