Recommendation Audiences

Community managers (users with the Create and Set Up Communities or Manage Communities permission) can access, create, and delete audiences, definitions, and schedules for community recommendations. Users with the Modify All Data permission can also access, create, and delete recommendation audiences, recommendation definitions, and scheduled recommendations.

Resource

1/connect/recommendation-audiences

1/connect/communities/communityId/recommendation-audiences

Available version

35.0

Requires Chatter

No

HTTP methods

GET, HEAD, POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
page	Integer	Zero-index page number. If not specified, page zero is used.	Optional	35.0
pageSize	Integer	Number of items per page. Default is 25.	Optional	35.0

Response body for GET

Recommendation Audience Collection

Request body for POST

Root XML tag

<recommendationAudience>

JSON example for creating a recommendation audience

1{ 
2   "name" : "Custom App Users"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
criteria	Custom List Audience Criteria Input or New User Audience Criteria Input	The criteria for the recommendation audience type.	Optional If not specified when creating a recommendation audience, the audience criteria type defaults to custom list.	36.0
member​OperationType	String	This property is available only in version 35.0. In version 36.0 and later, use Custom List Audience Criteria Input. Important 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 only
members	User ID Collection Input	This property is available only in version 35.0. In version 36.0 and later, use Custom List Audience Criteria Input. Important 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 100 audiences.	Required to update a recommendation audience Don’t use or specify null to create a recommendation audience	35.0 only
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 POST

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

Response body for POST

Recommendation Audience