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": "23d17773-51d1-4ff5-9285-891dea11b6cd",
  "DocumentKey": "35e67077-afe2-44a7-b5a8-2c82e8d4fb4d",
  "CreatedOn": "2026-01-02T05:44:26.7165781Z"
}

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>23d17773-51d1-4ff5-9285-891dea11b6cd</ContactKey>
  <CreatedOn>2026-01-02T00:44:26.7165781-05:00</CreatedOn>
  <DocumentKey>35e67077-afe2-44a7-b5a8-2c82e8d4fb4d</DocumentKey>
</DocumentFavorite>