Update a favourites list

Request

To update an existing favourites list for an account, send a PUT request to:

https://<host>:<port>/useractivityvault/v1/clientdata/account/{account}/favouriteslists/{id}

Headers

• Authorization: Bearer – bearer token

• Content-Type: application/json

Mandatory arguments

If you do not supply a value for a parameter that already has a value, it will be set to null.

So the recommended approach is to use a GET request to get the bookmark, make the required changes, then use this modified set of parameters in the body of the PUT request.

• account – the account ID (in both the path and the body)
• id – the ID of the favourites list (in both the path and the body)

Other arguments

• 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 favourites list expires (query parameter). This is to save storage space. Default (from configuration): one year.
• userId – not used in OPF 3
• deviceId – the ID of the device (in body). Note that favourites lists are not device-specific.
• name – a name for the favourites list (in body)
• creationDate – bookmark creation date/time, in ISO 8601 format. If you do not specify this, UAV sets it automatically.
• modifiedDate – bookmark 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 bookmark, as key/value pairs (in body)
• tags – optional tags (in body). You can attach as many as you need. Each tag is a string.

Example

A PUT request with this payload updates a favourites list for the specified account:

{
   "account": "account1234",
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

Example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account": "account1234",
  "creationDate": "2021-01-22T14:35:39.991Z",
  "modifiedDate": "2021-01-22T14:35:39.991Z",
  "metadata": {}
  "tags": []
}

See also

For full details of this API, see the User Activity Vault (UAV) API documentation.