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": "9ebf98e3-b67f-4742-b3a1-275cf8c3f174",
  "DocumentKey": "38b4a4c9-bdc2-4053-aa7c-9f9c07e021ab",
  "CreatedOn": "2026-10-10T20:18:34.5415591Z"
}

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>9ebf98e3-b67f-4742-b3a1-275cf8c3f174</ContactKey>
  <CreatedOn>2026-10-10T16:18:34.5415591-04:00</CreatedOn>
  <DocumentKey>38b4a4c9-bdc2-4053-aa7c-9f9c07e021ab</DocumentKey>
</DocumentFavorite>