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": "1ab2cf74-0acf-439b-805e-8f2fad0daa62",
  "DocumentKey": "308e1c98-3cdf-4df6-aa71-07648f18b846",
  "CreatedOn": "2026-11-12T07:16:31.0283011Z"
}

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>1ab2cf74-0acf-439b-805e-8f2fad0daa62</ContactKey>
  <CreatedOn>2026-11-12T02:16:31.0283011-05:00</CreatedOn>
  <DocumentKey>308e1c98-3cdf-4df6-aa71-07648f18b846</DocumentKey>
</DocumentFavorite>