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": "75afe664-2e90-4718-b0e2-d079cf0670ec",
  "DocumentKey": "c42be2a1-ea1d-4a5f-b5a1-7bf558ed33a9",
  "CreatedOn": "2026-01-13T23:08:06.2317273Z"
}

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>75afe664-2e90-4718-b0e2-d079cf0670ec</ContactKey>
  <CreatedOn>2026-01-13T18:08:06.2317273-05:00</CreatedOn>
  <DocumentKey>c42be2a1-ea1d-4a5f-b5a1-7bf558ed33a9</DocumentKey>
</DocumentFavorite>