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": "f17d5b21-d10d-477c-be58-6c193d79eed1",
  "DocumentKey": "872693f5-2de3-40ac-8729-d4a51bdc5c5e",
  "CreatedOn": "2025-12-07T01:28:23.54174Z"
}

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>f17d5b21-d10d-477c-be58-6c193d79eed1</ContactKey>
  <CreatedOn>2025-12-06T20:28:23.54174-05:00</CreatedOn>
  <DocumentKey>872693f5-2de3-40ac-8729-d4a51bdc5c5e</DocumentKey>
</DocumentFavorite>