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": "c209fa2e-1407-4d1b-8cf6-799dd52a3d55",
  "DocumentKey": "bc40034a-ef1b-4ff9-a15e-52ef5a992f93",
  "CreatedOn": "2026-10-27T08:48:22.0767041Z"
}

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>c209fa2e-1407-4d1b-8cf6-799dd52a3d55</ContactKey>
  <CreatedOn>2026-10-27T04:48:22.0767041-04:00</CreatedOn>
  <DocumentKey>bc40034a-ef1b-4ff9-a15e-52ef5a992f93</DocumentKey>
</DocumentFavorite>