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": "1701ca50-9b21-45be-ac9e-a5d5f64f46e9",
  "DocumentKey": "b102b782-43c4-43a0-9116-c23c52012d5a",
  "CreatedOn": "2025-10-27T07:57:07.6871508Z"
}

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>1701ca50-9b21-45be-ac9e-a5d5f64f46e9</ContactKey>
  <CreatedOn>2025-10-27T03:57:07.6871508-04:00</CreatedOn>
  <DocumentKey>b102b782-43c4-43a0-9116-c23c52012d5a</DocumentKey>
</DocumentFavorite>