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": "457464b3-b586-44f9-bbfb-a4ca4c989a96",
  "DocumentKey": "2de8092d-3fa3-4aa2-9040-ff7b1cd15635",
  "CreatedOn": "2025-12-23T03:08:02.6940111Z"
}

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>457464b3-b586-44f9-bbfb-a4ca4c989a96</ContactKey>
  <CreatedOn>2025-12-22T22:08:02.6940111-05:00</CreatedOn>
  <DocumentKey>2de8092d-3fa3-4aa2-9040-ff7b1cd15635</DocumentKey>
</DocumentFavorite>