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": "f5f73b20-a8c3-4e00-925c-89dd6839055e",
  "DocumentKey": "528c8d16-b81b-4e9a-b8a8-52dee7c41d1b",
  "CreatedOn": "2025-03-22T11:42:03.973816Z"
}

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>f5f73b20-a8c3-4e00-925c-89dd6839055e</ContactKey>
  <CreatedOn>2025-03-22T07:42:03.973816-04:00</CreatedOn>
  <DocumentKey>528c8d16-b81b-4e9a-b8a8-52dee7c41d1b</DocumentKey>
</DocumentFavorite>