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": "9d08d83e-1129-4297-a487-23793d8bffa7",
  "DocumentKey": "5ecee457-b868-474e-8116-3d60a0fd4a18",
  "CreatedOn": "2026-03-09T19:55:03.9107732Z"
}

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>9d08d83e-1129-4297-a487-23793d8bffa7</ContactKey>
  <CreatedOn>2026-03-09T15:55:03.9107732-04:00</CreatedOn>
  <DocumentKey>5ecee457-b868-474e-8116-3d60a0fd4a18</DocumentKey>
</DocumentFavorite>