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": "633326ec-1fa8-40c3-926e-49ad937f0afb",
  "DocumentKey": "9892fa8b-a625-4c64-bede-f58782a9dfab",
  "CreatedOn": "2021-05-18T02:36:18.3169788Z"
}

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>633326ec-1fa8-40c3-926e-49ad937f0afb</ContactKey>
  <CreatedOn>2021-05-17T22:36:18.3169788-04:00</CreatedOn>
  <DocumentKey>9892fa8b-a625-4c64-bede-f58782a9dfab</DocumentKey>
</DocumentFavorite>