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": "0ca4ae86-50be-4dab-ba8b-e8f8b15a2fa4",
  "DocumentKey": "d574caf7-c84f-43d8-b162-23bca7d232b7",
  "CreatedOn": "2026-03-01T12:04:17.2802514Z"
}

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>0ca4ae86-50be-4dab-ba8b-e8f8b15a2fa4</ContactKey>
  <CreatedOn>2026-03-01T07:04:17.2802514-05:00</CreatedOn>
  <DocumentKey>d574caf7-c84f-43d8-b162-23bca7d232b7</DocumentKey>
</DocumentFavorite>