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": "2030442e-c310-44a9-9f7f-a8aa053c6e7d",
  "DocumentKey": "ad16ab98-2c0c-45b8-a170-fbf622ccd8da",
  "CreatedOn": "2026-06-30T19:33:51.8341171Z"
}

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>2030442e-c310-44a9-9f7f-a8aa053c6e7d</ContactKey>
  <CreatedOn>2026-06-30T15:33:51.8341171-04:00</CreatedOn>
  <DocumentKey>ad16ab98-2c0c-45b8-a170-fbf622ccd8da</DocumentKey>
</DocumentFavorite>