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": "5cbb4a7a-ddd8-4275-96fd-19466462e0ef",
  "DocumentKey": "bf105f63-0999-4442-8fdb-d3b65abeab5c",
  "CreatedOn": "2026-10-25T23:58:48.9119444Z"
}

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>5cbb4a7a-ddd8-4275-96fd-19466462e0ef</ContactKey>
  <CreatedOn>2026-10-25T19:58:48.9119444-04:00</CreatedOn>
  <DocumentKey>bf105f63-0999-4442-8fdb-d3b65abeab5c</DocumentKey>
</DocumentFavorite>