POST api/v1.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": "e3df1822-fc87-4877-b174-057fdbb3cf5f",
  "DocumentKey": "f7fc5f80-885f-4bb1-9227-3c6d47a757bd",
  "CreatedOn": "2025-12-15T07:30:31.0290812Z"
}

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>e3df1822-fc87-4877-b174-057fdbb3cf5f</ContactKey>
  <CreatedOn>2025-12-15T02:30:31.0290812-05:00</CreatedOn>
  <DocumentKey>f7fc5f80-885f-4bb1-9227-3c6d47a757bd</DocumentKey>
</DocumentFavorite>