Custom Recommendation Audience Input

A custom recommendation audience.

Root XML tag

<recommendationAudience>

JSON example for updating a custom list recommendation audience

1{ 
2   "criteria" : {
3      "memberOperationType" : "Add",
4      "members" : {
5         "userIds" : [
6            "005B0000000Ge16",
7            "005D0000001GpHp"
8            ]
9         },
10      "type" : "CustomList"
11   },
12   "name" : "My Custom List"
13}

JSON example for updating a new members recommendation audience

1{ 
2   "criteria" : {
3      "value" : "30",
4      "type" : "MaxDaysInCommunity"
5   },
6   "name" : "New Hires"
7}

JSON example for creating a custom 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 custom recommendation audience type.	Optional If not specified when creating a recommendation audience, the audience criteria type defaults to custom list.	36.0
`memberOperationType`	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 Experience Cloud site 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 custom recommendation audience.	Optional to update a recommendation audience Required to create a recommendation audience	35.0

Connect REST API Developer Guide

Custom Recommendation Audience Input

See Also