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": "e40498b6-84fb-4b87-8a2f-4d1b6d4d2e33",
  "DocumentKey": "20728c96-9331-48bc-87e2-e15664d6272b",
  "CreatedOn": "2026-07-25T03:58:14.1372843Z"
}

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>e40498b6-84fb-4b87-8a2f-4d1b6d4d2e33</ContactKey>
  <CreatedOn>2026-07-24T23:58:14.1372843-04:00</CreatedOn>
  <DocumentKey>20728c96-9331-48bc-87e2-e15664d6272b</DocumentKey>
</DocumentFavorite>