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": "6f7589e5-2087-4e0d-9fd2-e04a791e6a40",
  "DocumentKey": "c28f8dfc-c1b4-4a2d-a39a-4d61e1bedfc8",
  "CreatedOn": "2026-01-18T05:26:23.3489505Z"
}

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>6f7589e5-2087-4e0d-9fd2-e04a791e6a40</ContactKey>
  <CreatedOn>2026-01-18T00:26:23.3489505-05:00</CreatedOn>
  <DocumentKey>c28f8dfc-c1b4-4a2d-a39a-4d61e1bedfc8</DocumentKey>
</DocumentFavorite>