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": "f70e6b7b-1a88-4a04-93b7-a65c5a263629",
  "DocumentKey": "6da368c6-901b-4f51-bb93-a218c24fcb96",
  "CreatedOn": "2026-04-27T17:24:06.7670287Z"
}

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>f70e6b7b-1a88-4a04-93b7-a65c5a263629</ContactKey>
  <CreatedOn>2026-04-27T13:24:06.7670287-04:00</CreatedOn>
  <DocumentKey>6da368c6-901b-4f51-bb93-a218c24fcb96</DocumentKey>
</DocumentFavorite>