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": "ca6c3bf7-637f-4b03-b283-699ffe13b2ce",
  "DocumentKey": "3a824042-e6d3-4794-81cf-152c65111bd1",
  "CreatedOn": "2025-12-10T12:35:53.8729526Z"
}

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>ca6c3bf7-637f-4b03-b283-699ffe13b2ce</ContactKey>
  <CreatedOn>2025-12-10T07:35:53.8729526-05:00</CreatedOn>
  <DocumentKey>3a824042-e6d3-4794-81cf-152c65111bd1</DocumentKey>
</DocumentFavorite>