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": "c38a5ef5-7fc3-4b9c-a2ea-31dd6af6a27a",
  "DocumentKey": "91b0f3d6-92c5-414f-ae79-a3a260c38702",
  "CreatedOn": "2025-12-23T12:40:14.7819448Z"
}

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>c38a5ef5-7fc3-4b9c-a2ea-31dd6af6a27a</ContactKey>
  <CreatedOn>2025-12-23T07:40:14.7819448-05:00</CreatedOn>
  <DocumentKey>91b0f3d6-92c5-414f-ae79-a3a260c38702</DocumentKey>
</DocumentFavorite>