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": "57f8c479-78b0-42ca-9f77-de13b9463649",
  "DocumentKey": "13b2e737-e2cc-4cc2-8e59-cd67bb5aca26",
  "CreatedOn": "2025-09-18T00:41:00.7378145Z"
}

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>57f8c479-78b0-42ca-9f77-de13b9463649</ContactKey>
  <CreatedOn>2025-09-17T20:41:00.7378145-04:00</CreatedOn>
  <DocumentKey>13b2e737-e2cc-4cc2-8e59-cd67bb5aca26</DocumentKey>
</DocumentFavorite>