POST api/v1.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": "fc7feceb-432d-4d75-ad81-5b640f0c6399",
  "DocumentKey": "db622e07-3c73-4b90-a70c-352e4a2c30c7",
  "CreatedOn": "2026-08-27T11:47:02.6068833Z"
}

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>fc7feceb-432d-4d75-ad81-5b640f0c6399</ContactKey>
  <CreatedOn>2026-08-27T07:47:02.6068833-04:00</CreatedOn>
  <DocumentKey>db622e07-3c73-4b90-a70c-352e4a2c30c7</DocumentKey>
</DocumentFavorite>