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": "01279f77-30db-4316-bbda-1bba45c281e7",
  "DocumentKey": "969ba28c-9ab3-41b4-950e-7c28be1b88aa",
  "CreatedOn": "2026-07-03T19:55:49.3976801Z"
}

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>01279f77-30db-4316-bbda-1bba45c281e7</ContactKey>
  <CreatedOn>2026-07-03T15:55:49.3976801-04:00</CreatedOn>
  <DocumentKey>969ba28c-9ab3-41b4-950e-7c28be1b88aa</DocumentKey>
</DocumentFavorite>