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": "527bf807-6b1f-4a68-bf99-f1fe2183b87d",
  "DocumentKey": "3f0a9fc5-afae-4a66-aee1-03df15f3477d",
  "CreatedOn": "2023-03-28T04:57:22.5522888Z"
}

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>527bf807-6b1f-4a68-bf99-f1fe2183b87d</ContactKey>
  <CreatedOn>2023-03-28T00:57:22.5522888-04:00</CreatedOn>
  <DocumentKey>3f0a9fc5-afae-4a66-aee1-03df15f3477d</DocumentKey>
</DocumentFavorite>