POST api/v1.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": "35bea034-7862-4323-ba3f-4a96135abecc",
  "DocumentKey": "8a4b2ac1-8f00-4d95-8c4a-28991f43827b",
  "CreatedOn": "2026-05-03T03:24:49.6538972Z"
}

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>35bea034-7862-4323-ba3f-4a96135abecc</ContactKey>
  <CreatedOn>2026-05-02T23:24:49.6538972-04:00</CreatedOn>
  <DocumentKey>8a4b2ac1-8f00-4d95-8c4a-28991f43827b</DocumentKey>
</DocumentFavorite>