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": "364c987c-0a08-476e-aea0-5055f128e80f",
  "DocumentKey": "9c3e52be-52db-4997-b964-247a1531cf14",
  "CreatedOn": "2026-01-15T13:49:38.5218703Z"
}

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>364c987c-0a08-476e-aea0-5055f128e80f</ContactKey>
  <CreatedOn>2026-01-15T08:49:38.5218703-05:00</CreatedOn>
  <DocumentKey>9c3e52be-52db-4997-b964-247a1531cf14</DocumentKey>
</DocumentFavorite>