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": "27d1cea8-1266-4e9d-b0de-52aac7ba41e6",
  "DocumentKey": "1ea1b552-cd50-4ecf-b6c8-9b18ef01ee8d",
  "CreatedOn": "2025-11-18T12:16:46.9016683Z"
}

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>27d1cea8-1266-4e9d-b0de-52aac7ba41e6</ContactKey>
  <CreatedOn>2025-11-18T07:16:46.9016683-05:00</CreatedOn>
  <DocumentKey>1ea1b552-cd50-4ecf-b6c8-9b18ef01ee8d</DocumentKey>
</DocumentFavorite>