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": "d0ac60f2-3f19-4c88-bf65-5d7ffd15ffa6",
  "DocumentKey": "baa7f2bc-0dbf-44b5-ad1d-c2a896bdf0a1",
  "CreatedOn": "2026-01-23T02:26:43.915437Z"
}

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>d0ac60f2-3f19-4c88-bf65-5d7ffd15ffa6</ContactKey>
  <CreatedOn>2026-01-22T21:26:43.915437-05:00</CreatedOn>
  <DocumentKey>baa7f2bc-0dbf-44b5-ad1d-c2a896bdf0a1</DocumentKey>
</DocumentFavorite>