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": "173437b1-afc4-451f-ac96-d0a38a4c87cc",
  "DocumentKey": "ff0865e9-64da-4855-b766-6326b1ae9cff",
  "CreatedOn": "2026-06-09T05:01:21.4769393Z"
}

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>173437b1-afc4-451f-ac96-d0a38a4c87cc</ContactKey>
  <CreatedOn>2026-06-09T01:01:21.4769393-04:00</CreatedOn>
  <DocumentKey>ff0865e9-64da-4855-b766-6326b1ae9cff</DocumentKey>
</DocumentFavorite>