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": "233fedfa-e61c-4942-a3c2-fea2220957d5",
  "DocumentKey": "2c573c39-f3b3-4cbe-804b-b73fb4185e90",
  "CreatedOn": "2026-05-27T00:13:18.5272027Z"
}

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>233fedfa-e61c-4942-a3c2-fea2220957d5</ContactKey>
  <CreatedOn>2026-05-26T20:13:18.5272027-04:00</CreatedOn>
  <DocumentKey>2c573c39-f3b3-4cbe-804b-b73fb4185e90</DocumentKey>
</DocumentFavorite>