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": "564ee019-14f8-4b5a-8e93-00770e980321",
  "DocumentKey": "ce1be1c9-a477-4c1b-b7ea-1be4aaca59e8",
  "CreatedOn": "2026-02-22T00:42:03.125518Z"
}

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>564ee019-14f8-4b5a-8e93-00770e980321</ContactKey>
  <CreatedOn>2026-02-21T19:42:03.125518-05:00</CreatedOn>
  <DocumentKey>ce1be1c9-a477-4c1b-b7ea-1be4aaca59e8</DocumentKey>
</DocumentFavorite>