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": "9c8fc44d-a5c4-4697-869d-2c806e5d59e6",
  "DocumentKey": "a2c15030-1d9c-4e01-98e4-7dd4123bdbc2",
  "CreatedOn": "2026-10-14T09:40:37.0992424Z"
}

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>9c8fc44d-a5c4-4697-869d-2c806e5d59e6</ContactKey>
  <CreatedOn>2026-10-14T05:40:37.0992424-04:00</CreatedOn>
  <DocumentKey>a2c15030-1d9c-4e01-98e4-7dd4123bdbc2</DocumentKey>
</DocumentFavorite>