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": "281cf340-24d3-42dd-86b7-38af81cb084c",
  "DocumentKey": "3b0a97cd-158b-4921-9fc6-27b246b61914",
  "CreatedOn": "2026-03-03T06:15:16.9714438Z"
}

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>281cf340-24d3-42dd-86b7-38af81cb084c</ContactKey>
  <CreatedOn>2026-03-03T01:15:16.9714438-05:00</CreatedOn>
  <DocumentKey>3b0a97cd-158b-4921-9fc6-27b246b61914</DocumentKey>
</DocumentFavorite>