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": "365a2b30-e4d3-47a3-b6bf-180ac69a8163",
  "DocumentKey": "4eef586e-b709-4b89-a865-6d922c79eb08",
  "CreatedOn": "2026-01-11T07:07:57.6034515Z"
}

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>365a2b30-e4d3-47a3-b6bf-180ac69a8163</ContactKey>
  <CreatedOn>2026-01-11T02:07:57.6034515-05:00</CreatedOn>
  <DocumentKey>4eef586e-b709-4b89-a865-6d922c79eb08</DocumentKey>
</DocumentFavorite>