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": "442e426f-59d0-4c97-9e6f-2db9b1bf9d10",
  "DocumentKey": "b26944c7-9ad7-49a2-b1fd-38317dc4e980",
  "CreatedOn": "2026-03-23T10:49:11.1772422Z"
}

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>442e426f-59d0-4c97-9e6f-2db9b1bf9d10</ContactKey>
  <CreatedOn>2026-03-23T06:49:11.1772422-04:00</CreatedOn>
  <DocumentKey>b26944c7-9ad7-49a2-b1fd-38317dc4e980</DocumentKey>
</DocumentFavorite>