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": "b3679aa6-e7a3-4bcb-bc14-267130a2763e",
  "DocumentKey": "f0681355-71b0-43d4-a6e8-6e952d849d59",
  "CreatedOn": "2026-01-12T07:57:08.1181032Z"
}

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>b3679aa6-e7a3-4bcb-bc14-267130a2763e</ContactKey>
  <CreatedOn>2026-01-12T02:57:08.1181032-05:00</CreatedOn>
  <DocumentKey>f0681355-71b0-43d4-a6e8-6e952d849d59</DocumentKey>
</DocumentFavorite>