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": "f84f9776-0a0e-4b7f-8038-4f5d24ee895c",
  "DocumentKey": "dd99e6e2-45ef-4ad3-ab42-27f3c330d635",
  "CreatedOn": "2026-01-26T09:37:20.0015934Z"
}

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>f84f9776-0a0e-4b7f-8038-4f5d24ee895c</ContactKey>
  <CreatedOn>2026-01-26T04:37:20.0015934-05:00</CreatedOn>
  <DocumentKey>dd99e6e2-45ef-4ad3-ab42-27f3c330d635</DocumentKey>
</DocumentFavorite>