POST api/v2.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": "2a9a4bdf-8fe1-4451-9939-da5f73884576",
  "DocumentKey": "e9bd7c31-8158-482a-8951-d5d8572a75af",
  "CreatedOn": "2024-10-18T04:58:17.1972563Z"
}

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>2a9a4bdf-8fe1-4451-9939-da5f73884576</ContactKey>
  <CreatedOn>2024-10-18T00:58:17.1972563-04:00</CreatedOn>
  <DocumentKey>e9bd7c31-8158-482a-8951-d5d8572a75af</DocumentKey>
</DocumentFavorite>