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": "daba9935-229b-45df-8994-f46fc7d5825d",
  "DocumentKey": "c3c30dd1-ad4c-4c67-ab20-34d46342c0f8",
  "CreatedOn": "2024-09-16T05:32:09.1016843Z"
}

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>daba9935-229b-45df-8994-f46fc7d5825d</ContactKey>
  <CreatedOn>2024-09-16T01:32:09.1016843-04:00</CreatedOn>
  <DocumentKey>c3c30dd1-ad4c-4c67-ab20-34d46342c0f8</DocumentKey>
</DocumentFavorite>