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": "b991c331-17c6-4c34-beee-33c35c44065b",
  "DocumentKey": "d616a029-8295-4158-964b-0594d175c16e",
  "CreatedOn": "2026-06-06T13:06:31.1294279Z"
}

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>b991c331-17c6-4c34-beee-33c35c44065b</ContactKey>
  <CreatedOn>2026-06-06T09:06:31.1294279-04:00</CreatedOn>
  <DocumentKey>d616a029-8295-4158-964b-0594d175c16e</DocumentKey>
</DocumentFavorite>