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": "c528fda7-4e2e-4639-9e4a-1a5e8d99dcbe",
  "DocumentKey": "578f8b54-fcb1-40bf-bacc-125db492833f",
  "CreatedOn": "2026-01-31T04:22:19.2688264Z"
}

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>c528fda7-4e2e-4639-9e4a-1a5e8d99dcbe</ContactKey>
  <CreatedOn>2026-01-30T23:22:19.2688264-05:00</CreatedOn>
  <DocumentKey>578f8b54-fcb1-40bf-bacc-125db492833f</DocumentKey>
</DocumentFavorite>