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": "d48baf60-339d-46e9-a4ca-ec7ca7840caa",
  "DocumentKey": "c74d4d9f-a478-4c2e-abfe-4c3c1ce9f431",
  "CreatedOn": "2026-05-07T15:54:36.6038195Z"
}

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>d48baf60-339d-46e9-a4ca-ec7ca7840caa</ContactKey>
  <CreatedOn>2026-05-07T11:54:36.6038195-04:00</CreatedOn>
  <DocumentKey>c74d4d9f-a478-4c2e-abfe-4c3c1ce9f431</DocumentKey>
</DocumentFavorite>