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": "7d8a31f5-c6d9-4844-8b68-72e423be1b2d",
  "DocumentKey": "8cc76b04-855e-4230-8d25-33b8ea974823",
  "CreatedOn": "2026-09-08T23:43:07.6725736Z"
}

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>7d8a31f5-c6d9-4844-8b68-72e423be1b2d</ContactKey>
  <CreatedOn>2026-09-08T19:43:07.6725736-04:00</CreatedOn>
  <DocumentKey>8cc76b04-855e-4230-8d25-33b8ea974823</DocumentKey>
</DocumentFavorite>