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": "d2df0056-a776-4d9f-9549-c48ae9ad12ba",
  "DocumentKey": "a28d93af-a29d-42c1-a5f7-15b54adc7b8c",
  "CreatedOn": "2023-10-04T19:14:39.096347Z"
}

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>d2df0056-a776-4d9f-9549-c48ae9ad12ba</ContactKey>
  <CreatedOn>2023-10-04T15:14:39.096347-04:00</CreatedOn>
  <DocumentKey>a28d93af-a29d-42c1-a5f7-15b54adc7b8c</DocumentKey>
</DocumentFavorite>