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": "3cf463f5-159c-4b4d-8127-edf00b35bf0c",
  "DocumentKey": "7d54b225-90c1-4697-86ad-2692d6cb011d",
  "CreatedOn": "2026-04-30T22:54:35.7677035Z"
}

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>3cf463f5-159c-4b4d-8127-edf00b35bf0c</ContactKey>
  <CreatedOn>2026-04-30T18:54:35.7677035-04:00</CreatedOn>
  <DocumentKey>7d54b225-90c1-4697-86ad-2692d6cb011d</DocumentKey>
</DocumentFavorite>