POST api/v2.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": "f099ae16-fc94-4aa0-8ca1-799e3e2bb534",
  "DocumentKey": "00846e38-8c2d-464c-a4ea-f6bd63de7e67",
  "CreatedOn": "2026-02-07T01:34:31.1922242Z"
}

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>f099ae16-fc94-4aa0-8ca1-799e3e2bb534</ContactKey>
  <CreatedOn>2026-02-06T20:34:31.1922242-05:00</CreatedOn>
  <DocumentKey>00846e38-8c2d-464c-a4ea-f6bd63de7e67</DocumentKey>
</DocumentFavorite>