POST api/v1.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": "203f09b7-b61d-49ee-b8b8-e94d55bc121d",
  "DocumentKey": "a078c774-0406-4b69-b80c-d34f97463d12",
  "CreatedOn": "2026-09-01T19:18:44.3588851Z"
}

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>203f09b7-b61d-49ee-b8b8-e94d55bc121d</ContactKey>
  <CreatedOn>2026-09-01T15:18:44.3588851-04:00</CreatedOn>
  <DocumentKey>a078c774-0406-4b69-b80c-d34f97463d12</DocumentKey>
</DocumentFavorite>