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": "e2d5fbb1-367d-4311-8167-3e41ad38705b",
  "DocumentKey": "918a84ea-586a-46c0-8e32-a5dc6f6ba998",
  "CreatedOn": "2026-07-30T05:38:26.5611493Z"
}

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>e2d5fbb1-367d-4311-8167-3e41ad38705b</ContactKey>
  <CreatedOn>2026-07-30T01:38:26.5611493-04:00</CreatedOn>
  <DocumentKey>918a84ea-586a-46c0-8e32-a5dc6f6ba998</DocumentKey>
</DocumentFavorite>