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": "bd5766e0-2496-41a9-96e7-0d02ad77d8d8",
  "DocumentKey": "35d4c7a8-7526-42b7-8c03-35760aa5a400",
  "CreatedOn": "2026-03-14T18:16:22.9550896Z"
}

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>bd5766e0-2496-41a9-96e7-0d02ad77d8d8</ContactKey>
  <CreatedOn>2026-03-14T14:16:22.9550896-04:00</CreatedOn>
  <DocumentKey>35d4c7a8-7526-42b7-8c03-35760aa5a400</DocumentKey>
</DocumentFavorite>