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": "1f9cf1c5-fa82-4777-afca-239add960be6",
  "DocumentKey": "314663d6-f62e-416b-9b11-663d83463a8b",
  "CreatedOn": "2024-10-29T18:00:38.0932007Z"
}

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>1f9cf1c5-fa82-4777-afca-239add960be6</ContactKey>
  <CreatedOn>2024-10-29T14:00:38.0932007-04:00</CreatedOn>
  <DocumentKey>314663d6-f62e-416b-9b11-663d83463a8b</DocumentKey>
</DocumentFavorite>