Recommendation Audience

Community managers (users with the “Create and Set Up Communities” or “Manage Communities” permission) can access, create, and delete recommendation audiences, recommendation definitions, and scheduled recommendations in their communities. Users with the “Modify All Data” permission can also access, create, and delete recommendation audiences, recommendation definitions, and scheduled recommendations.

These recommendations appear directly in the feed in communities in the Salesforce1 mobile browser app. They also appear, by default, on the right side of the home page and anywhere community managers add them using Community Builder in communities using the Summer ’15 or later version of the Napili template.

Resource

1/connect/recommendation-audiences/recommendationAudienceId

1/connect/communities/communityId/recommendation-audiences/recommendationAudienceId

Available version

35.0

Requires Chatter

No

HTTP methods

GET, HEAD, DELETE, PATCH

Response body for GET

Recommendation Audience

Request body for PATCH

Root XML tag

<recommendationAudience>

JSON example for updating a recommendation audience

1{ 
2   "memberOperationType" : "Add",
3   "members" : {
4      "userIds" : [
5         "005B0000000Ge16",
6         "005D0000001GpHp"
7         ]
8   },
9   "name" : "New Hires"
10}

Properties

Name	Type	Description	Required or Optional	Available Version
member​OperationType	String	The operation to carry out on the audience members. Values are: Add—Adds specified members to the audience. Remove—Removes specified members from the audience.	Required to update a recommendation audience Don’t use or specify null to create a recommendation audience	35.0
members	User ID Collection Input	A collection of user IDs. When updating an audience, you can include up to 100 members. An audience can have up to 100,000 members, and each community can have up to 1,000 audiences.	Required to update a recommendation audience Don’t use or specify null to create a recommendation audience	35.0
name	String	The unique name of the recommendation audience.	Optional to update a recommendation audience Required to create a recommendation audience	35.0

Request parameters for PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
name	String	The unique name of the recommendation audience.	Required	35.0

Response body for PATCH

Recommendation Audience

Response body for DELETE

204: Successful Delete