POST api/v1.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": "be2ae24e-b11b-4649-84f1-de1bbf77c4d7",
  "DocumentKey": "e7a84d78-0856-47ed-9e7e-a395762df7e8",
  "CreatedOn": "2025-06-02T13:33:32.3147788Z"
}

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>be2ae24e-b11b-4649-84f1-de1bbf77c4d7</ContactKey>
  <CreatedOn>2025-06-02T09:33:32.3147788-04:00</CreatedOn>
  <DocumentKey>e7a84d78-0856-47ed-9e7e-a395762df7e8</DocumentKey>
</DocumentFavorite>