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": "9c9f8e1e-9fb8-4448-91bc-04c3fe992220",
  "DocumentKey": "d57e4a45-0dfe-43bc-896a-22f596395d9b",
  "CreatedOn": "2026-02-10T02:19:59.0620358Z"
}

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>9c9f8e1e-9fb8-4448-91bc-04c3fe992220</ContactKey>
  <CreatedOn>2026-02-09T21:19:59.0620358-05:00</CreatedOn>
  <DocumentKey>d57e4a45-0dfe-43bc-896a-22f596395d9b</DocumentKey>
</DocumentFavorite>