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": "d4496bb1-c929-4142-8662-c317978cb963",
  "DocumentKey": "7ea6a7bf-2351-4318-9a3c-2ee2e8a309c9",
  "CreatedOn": "2026-11-05T16:08:39.8910863Z"
}

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>d4496bb1-c929-4142-8662-c317978cb963</ContactKey>
  <CreatedOn>2026-11-05T11:08:39.8910863-05:00</CreatedOn>
  <DocumentKey>7ea6a7bf-2351-4318-9a3c-2ee2e8a309c9</DocumentKey>
</DocumentFavorite>