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": "e0dd25d4-7cf7-4b98-bb74-4c4be7c711c8",
  "DocumentKey": "0493d47c-55d0-4d03-86ee-130845ca9a2a",
  "CreatedOn": "2026-02-13T23:03:25.18957Z"
}

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>e0dd25d4-7cf7-4b98-bb74-4c4be7c711c8</ContactKey>
  <CreatedOn>2026-02-13T18:03:25.18957-05:00</CreatedOn>
  <DocumentKey>0493d47c-55d0-4d03-86ee-130845ca9a2a</DocumentKey>
</DocumentFavorite>