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": "ae822af6-b088-4385-97fa-a595037ad737",
  "DocumentKey": "be767b5d-2be5-4df6-9c6c-3b01a98d72aa",
  "CreatedOn": "2026-05-03T19:22:26.2522706Z"
}

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>ae822af6-b088-4385-97fa-a595037ad737</ContactKey>
  <CreatedOn>2026-05-03T15:22:26.2522706-04:00</CreatedOn>
  <DocumentKey>be767b5d-2be5-4df6-9c6c-3b01a98d72aa</DocumentKey>
</DocumentFavorite>