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": "be749779-5aa6-4ae3-a58d-e5ea5aa4c252",
  "DocumentKey": "a82f2eaa-968f-4eec-a425-1d9543b29bc2",
  "CreatedOn": "2026-06-30T18:25:33.6566785Z"
}

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>be749779-5aa6-4ae3-a58d-e5ea5aa4c252</ContactKey>
  <CreatedOn>2026-06-30T14:25:33.6566785-04:00</CreatedOn>
  <DocumentKey>a82f2eaa-968f-4eec-a425-1d9543b29bc2</DocumentKey>
</DocumentFavorite>