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": "ae74b947-dced-4382-ad1d-f23cd72702c6",
  "DocumentKey": "296e3dc8-e57d-41dd-ab73-79b37ef0f0ed",
  "CreatedOn": "2025-12-05T18:34:45.0750529Z"
}

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>ae74b947-dced-4382-ad1d-f23cd72702c6</ContactKey>
  <CreatedOn>2025-12-05T13:34:45.0750529-05:00</CreatedOn>
  <DocumentKey>296e3dc8-e57d-41dd-ab73-79b37ef0f0ed</DocumentKey>
</DocumentFavorite>