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": "2372b6ff-a0f6-444e-9464-b927d09ec2e5",
  "DocumentKey": "5b41efec-0788-4bc9-aa21-2fd575db56cb",
  "CreatedOn": "2025-07-08T13:10:19.8745653Z"
}

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>2372b6ff-a0f6-444e-9464-b927d09ec2e5</ContactKey>
  <CreatedOn>2025-07-08T09:10:19.8745653-04:00</CreatedOn>
  <DocumentKey>5b41efec-0788-4bc9-aa21-2fd575db56cb</DocumentKey>
</DocumentFavorite>