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": "682e9443-2d23-4e55-b3c3-6980ca33bd38",
  "DocumentKey": "ee53ff14-e30a-4198-98dc-2b5930b32f94",
  "CreatedOn": "2026-07-23T09:59:40.7493623Z"
}

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>682e9443-2d23-4e55-b3c3-6980ca33bd38</ContactKey>
  <CreatedOn>2026-07-23T05:59:40.7493623-04:00</CreatedOn>
  <DocumentKey>ee53ff14-e30a-4198-98dc-2b5930b32f94</DocumentKey>
</DocumentFavorite>