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": "eb1e9f4c-1869-400a-a13e-0c6607058054",
  "DocumentKey": "9e298be9-fcb3-47f1-9e85-a05abd9ad8ed",
  "CreatedOn": "2025-07-03T03:09:00.1265235Z"
}

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>eb1e9f4c-1869-400a-a13e-0c6607058054</ContactKey>
  <CreatedOn>2025-07-02T23:09:00.1265235-04:00</CreatedOn>
  <DocumentKey>9e298be9-fcb3-47f1-9e85-a05abd9ad8ed</DocumentKey>
</DocumentFavorite>