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": "04080b02-39a4-4806-b6b6-7b0465bb7dd1",
  "DocumentKey": "4606bb3a-3d9a-44c0-a3e3-aec197382c8b",
  "CreatedOn": "2025-05-26T03:31:57.5911602Z"
}

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>04080b02-39a4-4806-b6b6-7b0465bb7dd1</ContactKey>
  <CreatedOn>2025-05-25T23:31:57.5911602-04:00</CreatedOn>
  <DocumentKey>4606bb3a-3d9a-44c0-a3e3-aec197382c8b</DocumentKey>
</DocumentFavorite>