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": "f700ed87-b961-4fb3-8409-d76ad8a71abe",
  "DocumentKey": "e267c78b-07de-477e-8049-00554b921587",
  "CreatedOn": "2025-08-30T14:18:31.9799949Z"
}

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>f700ed87-b961-4fb3-8409-d76ad8a71abe</ContactKey>
  <CreatedOn>2025-08-30T10:18:31.9799949-04:00</CreatedOn>
  <DocumentKey>e267c78b-07de-477e-8049-00554b921587</DocumentKey>
</DocumentFavorite>