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": "e4892ae8-38bf-4eb1-914f-a769c22dacfd",
  "DocumentKey": "0d9dfea6-5c29-4327-9422-01cd5d332b12",
  "CreatedOn": "2026-01-21T13:03:09.4049734Z"
}

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>e4892ae8-38bf-4eb1-914f-a769c22dacfd</ContactKey>
  <CreatedOn>2026-01-21T08:03:09.4049734-05:00</CreatedOn>
  <DocumentKey>0d9dfea6-5c29-4327-9422-01cd5d332b12</DocumentKey>
</DocumentFavorite>