Update an Audience Attribute.
put
/content/management/api/v1.1/personalization/audienceAttributes/{id}
Update an Audience Attribute with the given payload.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Id of the audience attributes.
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" ]
Update an Audience Attribute with the given information in the payload.
Root Schema : audienceAttributeInputInfo
Type:
object
Audience Attribute Input Information
Show Source
-
apiName(optional):
string
The reference name of the Audience Attribute. This is the name that is used in API calls that invoke the recommendation. If no reference name is provided the server will generate one from the name field. The referene name should be unique in a category.
-
categoryId:
string
The id of the Category the property belongs to.
-
description(optional):
string
The description of the Audience Attribute.
-
name:
string
The name of the Audience Attribute. It is a required property in the get response and cannot be empty in post/put request.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : audienceAttributeInfo
Type:
object
Audience Attribute Information
Show Source
-
apiName(optional):
string
The reference name of the Audience Attribute. This is the name that is used in API calls that invoke the recommendation. If no reference name is provided the server will generate one from the name field. The referene name should be unique in a category.
-
categoryId:
string
The id of the Category the property belongs to.
-
description(optional):
string
The description of the Audience Attribute.
-
id:
string
The id of the Audience Attribute. This is a required propety in the get response and ignored in post/put requests.
-
links(optional):
array links
Links
-
name:
string
The name of the Audience Attribute. It is a required property in the get response and cannot be empty in post/put request.
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.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Recommendation not found. The requested resource not found.
500 Response
Internal server error.