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": "05161697-2933-45e1-b681-c249eb6d478f",
  "DocumentKey": "28415056-72d2-4078-af3f-75378d5d13ea",
  "CreatedOn": "2025-06-19T10:39:44.0799462Z"
}

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>05161697-2933-45e1-b681-c249eb6d478f</ContactKey>
  <CreatedOn>2025-06-19T06:39:44.0799462-04:00</CreatedOn>
  <DocumentKey>28415056-72d2-4078-af3f-75378d5d13ea</DocumentKey>
</DocumentFavorite>