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": "2b4c7e0d-0e27-4d26-97b1-a56d5d0d3007",
  "DocumentKey": "25020c4b-87fc-4687-9e88-fe39e97f9adb",
  "CreatedOn": "2025-07-01T03:46:17.1163277Z"
}

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>2b4c7e0d-0e27-4d26-97b1-a56d5d0d3007</ContactKey>
  <CreatedOn>2025-06-30T23:46:17.1163277-04:00</CreatedOn>
  <DocumentKey>25020c4b-87fc-4687-9e88-fe39e97f9adb</DocumentKey>
</DocumentFavorite>