POST api/v2.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}

Add the specified Document to the Authenticated User's Favorite List.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentKey

DocumentKey of a Document.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

DocumentFavorite
NameDescriptionTypeAdditional information
ContactKey

globally unique identifier

None.
DocumentKey

globally unique identifier

None.
CreatedOn

date

None.

Response Formats

application/json, text/json

Sample: 
{
  "ContactKey": "ea10e186-9912-4e78-a9b8-c9df1cf1956b",
  "DocumentKey": "f023d064-0637-45c0-b1fc-c38d1393d6f1",
  "CreatedOn": "2023-04-01T11:46:23.824724Z"
}

application/xml, text/xml

Sample: 
<DocumentFavorite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ResourceLibrary">
  <ContactKey>ea10e186-9912-4e78-a9b8-c9df1cf1956b</ContactKey>
  <CreatedOn>2023-04-01T07:46:23.824724-04:00</CreatedOn>
  <DocumentKey>f023d064-0637-45c0-b1fc-c38d1393d6f1</DocumentKey>
</DocumentFavorite>