POST api/v1.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": "3c74b862-5912-4768-b4fd-9efd75a66b11",
  "DocumentKey": "90106a60-97a2-4213-94a2-b711cca1d7c6",
  "CreatedOn": "2024-12-22T11:23:47.9924838Z"
}

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>3c74b862-5912-4768-b4fd-9efd75a66b11</ContactKey>
  <CreatedOn>2024-12-22T06:23:47.9924838-05:00</CreatedOn>
  <DocumentKey>90106a60-97a2-4213-94a2-b711cca1d7c6</DocumentKey>
</DocumentFavorite>