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": "0af689c4-ae4b-45b5-b7ad-31c33a08db73",
  "DocumentKey": "0bdce0e7-5f85-4670-8715-d3524d6e4d8f",
  "CreatedOn": "2026-11-08T08:39:28.6034134Z"
}

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>0af689c4-ae4b-45b5-b7ad-31c33a08db73</ContactKey>
  <CreatedOn>2026-11-08T03:39:28.6034134-05:00</CreatedOn>
  <DocumentKey>0bdce0e7-5f85-4670-8715-d3524d6e4d8f</DocumentKey>
</DocumentFavorite>