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": "c97711fa-982b-4c85-b1a5-eb44beba191a",
  "DocumentKey": "1246209a-a110-4fd7-a48c-821977614469",
  "CreatedOn": "2025-04-18T22:24:43.1136714Z"
}

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>c97711fa-982b-4c85-b1a5-eb44beba191a</ContactKey>
  <CreatedOn>2025-04-18T18:24:43.1136714-04:00</CreatedOn>
  <DocumentKey>1246209a-a110-4fd7-a48c-821977614469</DocumentKey>
</DocumentFavorite>