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": "79175fac-d90e-40e1-804f-574fb5ca6e11",
  "DocumentKey": "4daa47ba-ab37-4bd3-82f4-9216bf991777",
  "CreatedOn": "2025-11-07T10:11:38.0373375Z"
}

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>79175fac-d90e-40e1-804f-574fb5ca6e11</ContactKey>
  <CreatedOn>2025-11-07T05:11:38.0373375-05:00</CreatedOn>
  <DocumentKey>4daa47ba-ab37-4bd3-82f4-9216bf991777</DocumentKey>
</DocumentFavorite>