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": "b668b0ed-6d69-4fed-9b31-7c1fd84b6b84",
  "DocumentKey": "983bf37e-f630-409b-a0d5-84f604b02fd1",
  "CreatedOn": "2026-02-12T13:01:31.2525791Z"
}

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>b668b0ed-6d69-4fed-9b31-7c1fd84b6b84</ContactKey>
  <CreatedOn>2026-02-12T08:01:31.2525791-05:00</CreatedOn>
  <DocumentKey>983bf37e-f630-409b-a0d5-84f604b02fd1</DocumentKey>
</DocumentFavorite>