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": "5bb183d3-1ea5-4e4d-97c6-391ce3390766",
  "DocumentKey": "86e16373-87aa-4ca0-86d2-651e1a0d3e8a",
  "CreatedOn": "2025-04-04T13:50:12.0513248Z"
}

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>5bb183d3-1ea5-4e4d-97c6-391ce3390766</ContactKey>
  <CreatedOn>2025-04-04T09:50:12.0513248-04:00</CreatedOn>
  <DocumentKey>86e16373-87aa-4ca0-86d2-651e1a0d3e8a</DocumentKey>
</DocumentFavorite>