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": "c31305bc-5ae4-4ba1-83f1-1c42e2d8c3cd",
  "DocumentKey": "30330669-62bf-4c85-973a-4f36afd4bb5f",
  "CreatedOn": "2026-08-27T18:45:44.743689Z"
}

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>c31305bc-5ae4-4ba1-83f1-1c42e2d8c3cd</ContactKey>
  <CreatedOn>2026-08-27T14:45:44.743689-04:00</CreatedOn>
  <DocumentKey>30330669-62bf-4c85-973a-4f36afd4bb5f</DocumentKey>
</DocumentFavorite>