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": "4af82d06-93da-46da-869c-63c7508fab50",
  "DocumentKey": "f39fae4b-f1d5-4d1c-a7ec-3bb1c43122c3",
  "CreatedOn": "2025-07-11T23:54:20.4666542Z"
}

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>4af82d06-93da-46da-869c-63c7508fab50</ContactKey>
  <CreatedOn>2025-07-11T19:54:20.4666542-04:00</CreatedOn>
  <DocumentKey>f39fae4b-f1d5-4d1c-a7ec-3bb1c43122c3</DocumentKey>
</DocumentFavorite>