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": "ca99e9f2-21f8-44da-8633-6ae94e6afa83",
  "DocumentKey": "da937e55-29a4-4143-a5e0-52ae6320a07b",
  "CreatedOn": "2026-01-05T08:49:32.0832587Z"
}

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>ca99e9f2-21f8-44da-8633-6ae94e6afa83</ContactKey>
  <CreatedOn>2026-01-05T03:49:32.0832587-05:00</CreatedOn>
  <DocumentKey>da937e55-29a4-4143-a5e0-52ae6320a07b</DocumentKey>
</DocumentFavorite>