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": "20d23af2-434c-4f92-b727-0a563dc2e70f",
  "DocumentKey": "6b4d5f36-7b36-4e74-9714-c4fea8f95514",
  "CreatedOn": "2026-10-31T01:02:43.5740792Z"
}

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>20d23af2-434c-4f92-b727-0a563dc2e70f</ContactKey>
  <CreatedOn>2026-10-30T21:02:43.5740792-04:00</CreatedOn>
  <DocumentKey>6b4d5f36-7b36-4e74-9714-c4fea8f95514</DocumentKey>
</DocumentFavorite>