POST api/v1.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": "9b3f11a1-12d8-484f-8fae-31bb06dd9e65",
  "DocumentKey": "643cb799-1e1d-4ea9-8562-581d26947976",
  "CreatedOn": "2025-09-13T15:57:25.0000922Z"
}

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>9b3f11a1-12d8-484f-8fae-31bb06dd9e65</ContactKey>
  <CreatedOn>2025-09-13T11:57:25.0000922-04:00</CreatedOn>
  <DocumentKey>643cb799-1e1d-4ea9-8562-581d26947976</DocumentKey>
</DocumentFavorite>