POST api/v1.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": "184f31af-4a51-457c-9f1b-c7a99595aa24",
  "DocumentKey": "ad2bd298-c70a-43b8-a27b-6a29171f8da3",
  "CreatedOn": "2026-03-06T17:18:58.8570069Z"
}

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>184f31af-4a51-457c-9f1b-c7a99595aa24</ContactKey>
  <CreatedOn>2026-03-06T12:18:58.8570069-05:00</CreatedOn>
  <DocumentKey>ad2bd298-c70a-43b8-a27b-6a29171f8da3</DocumentKey>
</DocumentFavorite>