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": "02ce2eec-9392-4761-bfd4-f7cfe179f53b",
  "DocumentKey": "32e222a0-b08c-4f6f-a92c-b542962c7d13",
  "CreatedOn": "2026-02-24T01:50:37.2919892Z"
}

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>02ce2eec-9392-4761-bfd4-f7cfe179f53b</ContactKey>
  <CreatedOn>2026-02-23T20:50:37.2919892-05:00</CreatedOn>
  <DocumentKey>32e222a0-b08c-4f6f-a92c-b542962c7d13</DocumentKey>
</DocumentFavorite>