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": "a4a5c71c-efef-4635-a38b-5ad70bdc41e9",
  "DocumentKey": "3962ec64-99ba-4522-97fc-e80e6c6879c9",
  "CreatedOn": "2026-04-11T07:05:46.1544321Z"
}

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>a4a5c71c-efef-4635-a38b-5ad70bdc41e9</ContactKey>
  <CreatedOn>2026-04-11T03:05:46.1544321-04:00</CreatedOn>
  <DocumentKey>3962ec64-99ba-4522-97fc-e80e6c6879c9</DocumentKey>
</DocumentFavorite>