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": "9bac0e5c-3c50-4aa7-9f25-cb9d35be27c1",
  "DocumentKey": "649b375c-7194-4acf-9ce1-0be3d7eae28a",
  "CreatedOn": "2026-06-04T07:53:42.7495874Z"
}

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>9bac0e5c-3c50-4aa7-9f25-cb9d35be27c1</ContactKey>
  <CreatedOn>2026-06-04T03:53:42.7495874-04:00</CreatedOn>
  <DocumentKey>649b375c-7194-4acf-9ce1-0be3d7eae28a</DocumentKey>
</DocumentFavorite>