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": "a26086e6-d4ae-46fc-88ed-b644e4ad2cce",
  "DocumentKey": "5236c53f-38a3-4d63-8a22-2fbcae04080b",
  "CreatedOn": "2026-11-19T02:47:27.7339321Z"
}

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>a26086e6-d4ae-46fc-88ed-b644e4ad2cce</ContactKey>
  <CreatedOn>2026-11-18T21:47:27.7339321-05:00</CreatedOn>
  <DocumentKey>5236c53f-38a3-4d63-8a22-2fbcae04080b</DocumentKey>
</DocumentFavorite>