Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Topics on Records Resource

The topics assigned to the specified record. Get information about topics assigned to the specified record, and add and remove topics from the specified record. Administrators must enable topics for objects before users can add topics to records of that object type.
Resource
1/connect/records/recordId/topics
Available since version
30.0
HTTP methods
GET, DELETE, POST
Request parameters for DELETE
Parameter Name Type Description Required or Optional Available Version
topicId String ID of an existing topic Required 30.0
Response body for DELETE
204: Successful Delete
Request body for POST
Root XML tag
<topicAssignment>
JSON
The following example assigns a topic to a record:
1{ "topicId": "0TOD0000000090r"
2}
Properties
Name Type Description Required or Optional Available Version
topicId String ID of an existing topic. Required for existing topics if the topicName property isn’t used. 30.0
topicName String Name of a new or existing topic. Required for new topics; required for existing topics if the topicId property isn’t used. 30.0
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
topicId String ID of an existing topic Required for existing topics if the topicName parameter isn’t used 30.0
topicName String Name of a new or existing topic Required for new topics; required for existing topics if the topicId parameter isn’t used 30.0
Response body for POST
Topic
Example for POST
This example passes the ID of an existing topic in the topidId parameter to associate it with an opportunity record:
1POST /connect/records/006D000000CtYBc/topics?topicId=0TOD0000000090r

This is the JSON response:

1{
2   "createdDate": "2013-02-25T18:24:31.000Z",
3   "id": "0TOD0000000090rOAA",
4   "description": "Test topic description.",
5   "talkingAbout": 9,
6   "name": "Test",
7   "url": "/services/data/v30.0/chatter/topics/0TOD0000000090rOAA"
8}