Add a favourite to a favourites list

Request

To add a favourite to a favourites list for an account, send a PUT request to:

https://<host>:<port>/useractivityvault/v1/clientdata/account/{account}/favouriteslists/{favouriteListId}/content/{contentId}

account – the account ID (in path)
favouriteListId – the ID of the favourites list to add the favourite to (in both the path and the body)
contentId – the ID of the content to be added as a favourite (in both the path and the body)

pretty – specifies that the output should be pretty-printed (that is, in human-readable format) (query parameter)
expires – the time (in seconds) after which the bookmark expires (query parameter). This is to save storage space. Default (from configuration): one year.
contentType – the content's type (in body), for example, VOD or live. Each category is a string.
name – a name for the favourite (in body)
categories – the categories (one or more) that the favourite belongs to. The value of each category can be any string.
creationDate – favourite creation date/time, in ISO 8601 format. If you do not specify this, UAV sets it automatically.
modifiedDate – favourite last modified date/time, in ISO 8601 format. If you do not specify this, UAV sets it automatically.
metadata – any additional information that you need to attach to the favourite, as key/value pairs (in body)

A PUT request with this payload adds a favourite to the specified favourites list for the specified account:

CODE

{
  "favouriteListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contentId": "Die Hard"
}

Note that the favourites list ID and the content ID must also be specified in the path.

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.