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": "f02e9f8e-dff5-48a4-a4c7-4c505c7ec62d",
  "DocumentKey": "dc08c9b7-9fc2-4250-823f-c9a71ee1aba4",
  "CreatedOn": "2024-12-06T00:53:07.3668485Z"
}

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>f02e9f8e-dff5-48a4-a4c7-4c505c7ec62d</ContactKey>
  <CreatedOn>2024-12-05T19:53:07.3668485-05:00</CreatedOn>
  <DocumentKey>dc08c9b7-9fc2-4250-823f-c9a71ee1aba4</DocumentKey>
</DocumentFavorite>