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": "f8fbcde3-e0f3-4717-b3df-87e4b35ef3fa",
  "DocumentKey": "d3356947-2ad5-424a-94c5-d06e020ed101",
  "CreatedOn": "2025-11-05T23:31:19.444986Z"
}

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>f8fbcde3-e0f3-4717-b3df-87e4b35ef3fa</ContactKey>
  <CreatedOn>2025-11-05T18:31:19.444986-05:00</CreatedOn>
  <DocumentKey>d3356947-2ad5-424a-94c5-d06e020ed101</DocumentKey>
</DocumentFavorite>