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": "eb02bde1-2c38-45d1-af40-edbb78c95ed1",
  "DocumentKey": "d15f57a9-26db-4564-93e5-de3775949d9c",
  "CreatedOn": "2025-09-17T20:49:53.7805671Z"
}

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>eb02bde1-2c38-45d1-af40-edbb78c95ed1</ContactKey>
  <CreatedOn>2025-09-17T16:49:53.7805671-04:00</CreatedOn>
  <DocumentKey>d15f57a9-26db-4564-93e5-de3775949d9c</DocumentKey>
</DocumentFavorite>