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": "2ec13aa5-8b03-4ab0-8d98-b7ff4efdd3c7",
  "DocumentKey": "6673417e-baa2-45a8-9058-3b55247a5fad",
  "CreatedOn": "2025-10-15T21:12:43.7630717Z"
}

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>2ec13aa5-8b03-4ab0-8d98-b7ff4efdd3c7</ContactKey>
  <CreatedOn>2025-10-15T17:12:43.7630717-04:00</CreatedOn>
  <DocumentKey>6673417e-baa2-45a8-9058-3b55247a5fad</DocumentKey>
</DocumentFavorite>