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": "9a63a937-ad4c-48a3-839d-3c6a4001d46d",
  "DocumentKey": "bec94a95-fae1-498c-bd15-ffeb1aebe0a8",
  "CreatedOn": "2025-11-12T10:22:54.172806Z"
}

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>9a63a937-ad4c-48a3-839d-3c6a4001d46d</ContactKey>
  <CreatedOn>2025-11-12T05:22:54.172806-05:00</CreatedOn>
  <DocumentKey>bec94a95-fae1-498c-bd15-ffeb1aebe0a8</DocumentKey>
</DocumentFavorite>