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": "379a7226-e584-4c4d-9bdb-c9079bd05a3f",
  "DocumentKey": "6866f23f-3870-4f43-8ea1-cce15db539d8",
  "CreatedOn": "2024-07-27T08:20:20.7508904Z"
}

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>379a7226-e584-4c4d-9bdb-c9079bd05a3f</ContactKey>
  <CreatedOn>2024-07-27T04:20:20.7508904-04:00</CreatedOn>
  <DocumentKey>6866f23f-3870-4f43-8ea1-cce15db539d8</DocumentKey>
</DocumentFavorite>