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": "6ac725b3-571f-4975-bb88-ffcf0700b424",
  "DocumentKey": "6fd0c1b4-1caa-45f5-af96-6b8a80340da4",
  "CreatedOn": "2026-08-15T07:08:38.0054331Z"
}

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>6ac725b3-571f-4975-bb88-ffcf0700b424</ContactKey>
  <CreatedOn>2026-08-15T03:08:38.0054331-04:00</CreatedOn>
  <DocumentKey>6fd0c1b4-1caa-45f5-af96-6b8a80340da4</DocumentKey>
</DocumentFavorite>