Unpublish a Recommendation.
post
/content/management/api/v1.1/personalization/recommendations/{id}/unpublish
Unpublish a Recommendation from optional channel(s).
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Id of the Recommendation.
Query Parameters
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
The information needed to unpublish a Recommendation.
Root Schema : RecommendationUnpublish
Type:
object
Recommendation Unpublish Request
Show Source
-
allowUnpublishFromActiveSite(optional):
boolean
whether to allow active site items (recommendtion and defaults) to be unpublished.(defaults to false)
-
channels(optional):
array channels
List of unpublish channels. If channels are not empty, the recommendation is unpublished to the given channels. If the channels are empty, the recommendation is unpublished from its targeted channels.
Nested Schema : channels
Type:
array
List of unpublish channels. If channels are not empty, the recommendation is unpublished to the given channels. If the channels are empty, the recommendation is unpublished from its targeted channels.
Show Source
-
Array of:
object ChannelId
ChannelId
Nested Schema : ChannelId
Type:
object
ChannelId
Show Source
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
Response
Supported Media Types
- application/json
202 Response
Accepted.
400 Response
Bad request.
403 Response
Forbidden.
500 Response
Internal server error.