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": "864b15c9-d3d4-4dd0-9766-a4c7b8c45f06",
  "DocumentKey": "9b6b167a-7814-4f63-9a25-fe701248c960",
  "CreatedOn": "2026-05-07T07:00:55.2244053Z"
}

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>864b15c9-d3d4-4dd0-9766-a4c7b8c45f06</ContactKey>
  <CreatedOn>2026-05-07T03:00:55.2244053-04:00</CreatedOn>
  <DocumentKey>9b6b167a-7814-4f63-9a25-fe701248c960</DocumentKey>
</DocumentFavorite>