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": "fcaf1d6b-fa8d-4a89-9732-1926729d75f7",
  "DocumentKey": "0b56d0f9-a634-4cd6-8d3a-70d9fa780b95",
  "CreatedOn": "2026-07-22T02:55:36.6068167Z"
}

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>fcaf1d6b-fa8d-4a89-9732-1926729d75f7</ContactKey>
  <CreatedOn>2026-07-21T22:55:36.6068167-04:00</CreatedOn>
  <DocumentKey>0b56d0f9-a634-4cd6-8d3a-70d9fa780b95</DocumentKey>
</DocumentFavorite>