Newer Version Available

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

Managed Topics

Get all the managed topics for a community. Create a managed topic. Reorder managed topics.

Only community managers (users with the “Create and Set Up Communities” or “Manage Communities” permission) can create or reorder managed topics.

Resource
1/connect/communities/communityId/managed-topics
Available version
32.0
Requires Chatter
No
HTTP methods
GET, POST, PATCH, HEAD
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
managedTopic​Type String Type of managed topic.
  • Featured—Topics that are featured, for example, on the community home page, but don’t provide overall navigation.
  • Navigational—Topics that display in a navigational menu in the community.

A topic can be associated with up to two managed topic types, so a topic can be both a Featured topic and a Navigational topic.

Optional 32.0
Response body for GET
Managed Topic Collection
Request body for POST
Root XML tag
<managedTopic>
JSON example
1{
2"managedTopicType" :"Featured",
3"recordId" :"0TOD00000000cwk"
4}
Properties
Name Type Description Required or Optional Available Version
managedTopic​Type String Type of managed topic.
  • Featured—Topics that are featured, for example, on the community home page, but don’t provide overall navigation.
  • Navigational—Topics that display in a navigational menu in the community.

A topic can be associated with up to two managed topic types, so a topic can be both a Featured topic and a Navigational topic.

You can create up to 25 managed topics per managedTopicType.

Required 32.0
name String Name of the managed topic. Required for new topics

You must specify either name or recordId. You can’t specify both.

32.0
recordId String ID of the record to become a managed topic.

In version 32.0, recordId must be a topic ID.

Required for existing topics if the Name property isn’t used

You must specify either name or recordId. You can’t specify both.

32.0
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
managedTopic​Type String Type of managed topic.
  • Featured—Topics that are featured, for example, on the community home page, but don’t provide overall navigation.
  • Navigational—Topics that display in a navigational menu in the community.

A topic can be associated with up to two managed topic types, so a topic can be both a Featured topic and a Navigational topic.

You can create up to 25 managed topics per managedTopicType.

Required 32.0
name String Name of the managed topic. Required for new topics

You must specify either name or recordId. You can’t specify both.

32.0
recordId String ID of the record to become a managed topic.

In version 32.0, recordId must be a topic ID.

Required if the Name property isn’t used

You must specify either name or recordId. You can’t specify both.

32.0
Response body for POST
Managed Topic
Request body for PATCH
Root XML tag
<managedTopicPositionCollection>
JSON example
1{
2"managedTopicPositions" : [
3  {
4    "managedTopicId" :"0mtD0000000001aIAA",
5    "position" :"0"
6  },
7  {
8    "managedTopicId" :"0mtD0000000002qIAA",
9    "position" :"2"
10  }
11  ]
12}
Properties
Name Type Description Required or Optional Available Version
managedTopic​Positions Managed Topic Position Input[] Collection of managed topic position request bodies. This collection can include Featured and Navigational managed topics and doesn’t need to include all managed topics.

If you don’t include all managed topics in managedTopicPositions, the managed topics are reordered by respecting the positions indicated in managedTopicPositions and then by pushing down any managed topics that aren’t included in managedTopicPositions to the next available position. See Reorder managed topics example.

Required 32.0
Reorder managed topics example

If you have these managed topics:

Managed Topic Position
ManagedTopicA 0
ManagedTopicB 1
ManagedTopicC 2
ManagedTopicD 3
ManagedTopicE 4

And you reorder managed topics by including this information in Managed Topic Position Collection Input:

Managed Topic Position
ManagedTopicD 0
ManagedTopicE 2

The result is:

Managed Topic Position
ManagedTopicD 0
ManagedTopicA 1
ManagedTopicE 2
ManagedTopicB 3
ManagedTopicC 4
Response body for PATCH
Managed Topic Collection