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": "7948439d-4f53-4354-a257-76a2884d4359",
  "DocumentKey": "67ec4b42-d093-4617-b421-e3c061a50539",
  "CreatedOn": "2025-12-12T20:12:42.5568569Z"
}

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>7948439d-4f53-4354-a257-76a2884d4359</ContactKey>
  <CreatedOn>2025-12-12T15:12:42.5568569-05:00</CreatedOn>
  <DocumentKey>67ec4b42-d093-4617-b421-e3c061a50539</DocumentKey>
</DocumentFavorite>