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": "38850fa0-9561-4e6b-a9f9-ca547f58426b",
  "DocumentKey": "cf146719-545a-4394-9629-7d10ca7ba12f",
  "CreatedOn": "2026-05-18T06:17:27.9280008Z"
}

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>38850fa0-9561-4e6b-a9f9-ca547f58426b</ContactKey>
  <CreatedOn>2026-05-18T02:17:27.9280008-04:00</CreatedOn>
  <DocumentKey>cf146719-545a-4394-9629-7d10ca7ba12f</DocumentKey>
</DocumentFavorite>