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": "5e1d0fe1-43c9-4828-9d36-2da960a36241",
  "DocumentKey": "b9a374cc-1384-47bd-9a4e-10e3b8b70199",
  "CreatedOn": "2026-04-10T11:51:17.9670238Z"
}

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>5e1d0fe1-43c9-4828-9d36-2da960a36241</ContactKey>
  <CreatedOn>2026-04-10T07:51:17.9670238-04:00</CreatedOn>
  <DocumentKey>b9a374cc-1384-47bd-9a4e-10e3b8b70199</DocumentKey>
</DocumentFavorite>