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": "41ccf620-c4c3-4f64-a386-11a9f16cf311",
  "DocumentKey": "9abd9ed9-2334-4cd7-9994-7960276db569",
  "CreatedOn": "2025-12-11T03:48:34.7457644Z"
}

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>41ccf620-c4c3-4f64-a386-11a9f16cf311</ContactKey>
  <CreatedOn>2025-12-10T22:48:34.7457644-05:00</CreatedOn>
  <DocumentKey>9abd9ed9-2334-4cd7-9994-7960276db569</DocumentKey>
</DocumentFavorite>