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": "0f959a16-2d3b-413c-9868-2e4b532bb094",
  "DocumentKey": "23836771-355a-4e5b-84e8-5ad5e480200e",
  "CreatedOn": "2025-11-08T13:21:37.8774657Z"
}

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>0f959a16-2d3b-413c-9868-2e4b532bb094</ContactKey>
  <CreatedOn>2025-11-08T08:21:37.8774657-05:00</CreatedOn>
  <DocumentKey>23836771-355a-4e5b-84e8-5ad5e480200e</DocumentKey>
</DocumentFavorite>