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": "73dd06ec-baf7-4fb5-8fe7-6e55674de112",
  "DocumentKey": "bd166c4f-701f-4497-897a-7caf3b8b3a60",
  "CreatedOn": "2026-02-02T09:20:51.9450948Z"
}

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>73dd06ec-baf7-4fb5-8fe7-6e55674de112</ContactKey>
  <CreatedOn>2026-02-02T04:20:51.9450948-05:00</CreatedOn>
  <DocumentKey>bd166c4f-701f-4497-897a-7caf3b8b3a60</DocumentKey>
</DocumentFavorite>