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": "cd2dfb07-16ae-49cb-90f6-3c28357a80d6",
  "DocumentKey": "cf9220f3-5c24-45dd-ad41-dbcd8fd37f73",
  "CreatedOn": "2026-07-30T11:00:12.9299675Z"
}

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>cd2dfb07-16ae-49cb-90f6-3c28357a80d6</ContactKey>
  <CreatedOn>2026-07-30T07:00:12.9299675-04:00</CreatedOn>
  <DocumentKey>cf9220f3-5c24-45dd-ad41-dbcd8fd37f73</DocumentKey>
</DocumentFavorite>