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": "38b14ddb-c482-445f-9aeb-ffe34be60893",
  "DocumentKey": "fa673659-0760-4607-9833-8425a70cb3bb",
  "CreatedOn": "2026-04-25T08:27:30.5368599Z"
}

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>38b14ddb-c482-445f-9aeb-ffe34be60893</ContactKey>
  <CreatedOn>2026-04-25T04:27:30.5368599-04:00</CreatedOn>
  <DocumentKey>fa673659-0760-4607-9833-8425a70cb3bb</DocumentKey>
</DocumentFavorite>