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": "5c9adce1-1a68-4e20-a2fd-de2912546d29",
  "DocumentKey": "a86991bc-13e9-4e46-b12a-08cee9830b7b",
  "CreatedOn": "2026-06-13T02:10:37.0234761Z"
}

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>5c9adce1-1a68-4e20-a2fd-de2912546d29</ContactKey>
  <CreatedOn>2026-06-12T22:10:37.0234761-04:00</CreatedOn>
  <DocumentKey>a86991bc-13e9-4e46-b12a-08cee9830b7b</DocumentKey>
</DocumentFavorite>