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": "21d9f990-16a8-409e-8ce0-d38bcd2ca7af",
  "DocumentKey": "fdea0a03-ffd3-480d-93bf-80f60983846d",
  "CreatedOn": "2026-01-25T20:34:59.1234235Z"
}

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>21d9f990-16a8-409e-8ce0-d38bcd2ca7af</ContactKey>
  <CreatedOn>2026-01-25T15:34:59.1234235-05:00</CreatedOn>
  <DocumentKey>fdea0a03-ffd3-480d-93bf-80f60983846d</DocumentKey>
</DocumentFavorite>