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": "e6cc5913-cd7c-49ca-b843-607b192b88a0",
  "DocumentKey": "c6332f44-8a2a-4b1b-a66e-0785ed6b3b7b",
  "CreatedOn": "2026-07-16T09:38:05.4177938Z"
}

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>e6cc5913-cd7c-49ca-b843-607b192b88a0</ContactKey>
  <CreatedOn>2026-07-16T05:38:05.4177938-04:00</CreatedOn>
  <DocumentKey>c6332f44-8a2a-4b1b-a66e-0785ed6b3b7b</DocumentKey>
</DocumentFavorite>