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": "e10570b6-df68-42ef-9518-0d710b98c726",
  "DocumentKey": "54a7e62c-a526-4250-9075-c42e75b06dac",
  "CreatedOn": "2025-01-15T07:19:59.7603803Z"
}

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>e10570b6-df68-42ef-9518-0d710b98c726</ContactKey>
  <CreatedOn>2025-01-15T02:19:59.7603803-05:00</CreatedOn>
  <DocumentKey>54a7e62c-a526-4250-9075-c42e75b06dac</DocumentKey>
</DocumentFavorite>