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": "9ae6f41d-6280-4de0-aab1-438b9569a3af",
  "DocumentKey": "dc80e06f-d679-4bbf-af9d-0f111c832115",
  "CreatedOn": "2026-01-23T21:02:48.1648881Z"
}

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>9ae6f41d-6280-4de0-aab1-438b9569a3af</ContactKey>
  <CreatedOn>2026-01-23T16:02:48.1648881-05:00</CreatedOn>
  <DocumentKey>dc80e06f-d679-4bbf-af9d-0f111c832115</DocumentKey>
</DocumentFavorite>