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": "05aeb0b5-aaf2-491b-bf58-5e8a0a10952a",
  "DocumentKey": "da9f5610-219d-4b60-a8b7-26f32d454c36",
  "CreatedOn": "2026-09-18T03:05:15.7611872Z"
}

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>05aeb0b5-aaf2-491b-bf58-5e8a0a10952a</ContactKey>
  <CreatedOn>2026-09-17T23:05:15.7611872-04:00</CreatedOn>
  <DocumentKey>da9f5610-219d-4b60-a8b7-26f32d454c36</DocumentKey>
</DocumentFavorite>