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": "6e9c35b8-bee7-4eed-bc91-cdc6f2a3270a",
  "DocumentKey": "698d0c81-ba27-449e-8207-0d09d51a1be6",
  "CreatedOn": "2025-10-13T18:09:08.2362269Z"
}

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>6e9c35b8-bee7-4eed-bc91-cdc6f2a3270a</ContactKey>
  <CreatedOn>2025-10-13T14:09:08.2362269-04:00</CreatedOn>
  <DocumentKey>698d0c81-ba27-449e-8207-0d09d51a1be6</DocumentKey>
</DocumentFavorite>