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": "cea53382-7f2a-4ccd-8f87-86228f699c28",
  "DocumentKey": "da3e74b1-f9d6-4156-b27d-8428097625d1",
  "CreatedOn": "2026-04-21T18:12:45.3122152Z"
}

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>cea53382-7f2a-4ccd-8f87-86228f699c28</ContactKey>
  <CreatedOn>2026-04-21T14:12:45.3122152-04:00</CreatedOn>
  <DocumentKey>da3e74b1-f9d6-4156-b27d-8428097625d1</DocumentKey>
</DocumentFavorite>