POST api/v2.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": "d8cb4b0f-3921-434e-a85a-98209b22a0a8",
  "DocumentKey": "bcd9394d-d421-4eab-9ddd-f3b1b25b9ba7",
  "CreatedOn": "2026-08-09T06:56:26.6668738Z"
}

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>d8cb4b0f-3921-434e-a85a-98209b22a0a8</ContactKey>
  <CreatedOn>2026-08-09T02:56:26.6668738-04:00</CreatedOn>
  <DocumentKey>bcd9394d-d421-4eab-9ddd-f3b1b25b9ba7</DocumentKey>
</DocumentFavorite>