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": "e35b1c5d-2632-4e5d-80c3-229591eab9e9",
  "DocumentKey": "0bc50c1a-06c5-43d2-93ed-14081f2b68be",
  "CreatedOn": "2025-03-17T21:41:34.7467165Z"
}

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>e35b1c5d-2632-4e5d-80c3-229591eab9e9</ContactKey>
  <CreatedOn>2025-03-17T17:41:34.7467165-04:00</CreatedOn>
  <DocumentKey>0bc50c1a-06c5-43d2-93ed-14081f2b68be</DocumentKey>
</DocumentFavorite>