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": "1b673f29-e5e7-4de5-8544-0cf7f4b41c94",
  "DocumentKey": "bbe0b4c0-aa24-4770-bc78-85610bb2f14d",
  "CreatedOn": "2026-04-29T18:51:16.3940456Z"
}

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>1b673f29-e5e7-4de5-8544-0cf7f4b41c94</ContactKey>
  <CreatedOn>2026-04-29T14:51:16.3940456-04:00</CreatedOn>
  <DocumentKey>bbe0b4c0-aa24-4770-bc78-85610bb2f14d</DocumentKey>
</DocumentFavorite>