POST api/v1.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": "e90cd694-9598-48d9-814b-b0ac0af9ef53",
  "DocumentKey": "aa7b8df2-9645-40fa-b421-f182354ff993",
  "CreatedOn": "2026-07-02T09:06:20.4756705Z"
}

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>e90cd694-9598-48d9-814b-b0ac0af9ef53</ContactKey>
  <CreatedOn>2026-07-02T05:06:20.4756705-04:00</CreatedOn>
  <DocumentKey>aa7b8df2-9645-40fa-b421-f182354ff993</DocumentKey>
</DocumentFavorite>