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": "1edd8219-03c8-4a63-b64c-8d1185784173",
  "DocumentKey": "f455ba17-cdd6-40b8-8f4e-d5844bae23c8",
  "CreatedOn": "2026-07-24T17:59:30.2440897Z"
}

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>1edd8219-03c8-4a63-b64c-8d1185784173</ContactKey>
  <CreatedOn>2026-07-24T13:59:30.2440897-04:00</CreatedOn>
  <DocumentKey>f455ba17-cdd6-40b8-8f4e-d5844bae23c8</DocumentKey>
</DocumentFavorite>