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": "5ede7e3b-d4c9-49c9-bf9c-cb68c007968e",
  "DocumentKey": "0690dac9-c989-45ef-9641-b721ca9a4f96",
  "CreatedOn": "2025-11-24T10:51:17.4200565Z"
}

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>5ede7e3b-d4c9-49c9-bf9c-cb68c007968e</ContactKey>
  <CreatedOn>2025-11-24T05:51:17.4200565-05:00</CreatedOn>
  <DocumentKey>0690dac9-c989-45ef-9641-b721ca9a4f96</DocumentKey>
</DocumentFavorite>