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": "01b2dc08-296a-4f4e-9331-2ac6ad889d49",
  "DocumentKey": "15b5e9b3-bd97-47ca-8aee-6c39e3dfc7f5",
  "CreatedOn": "2026-10-08T16:52:37.3749584Z"
}

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>01b2dc08-296a-4f4e-9331-2ac6ad889d49</ContactKey>
  <CreatedOn>2026-10-08T12:52:37.3749584-04:00</CreatedOn>
  <DocumentKey>15b5e9b3-bd97-47ca-8aee-6c39e3dfc7f5</DocumentKey>
</DocumentFavorite>