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": "8d394356-57ec-4f63-a53d-0f71348549b3",
  "DocumentKey": "be28b35e-5db7-4972-8011-bb4ee7a30ec7",
  "CreatedOn": "2025-03-12T11:22:45.331352Z"
}

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>8d394356-57ec-4f63-a53d-0f71348549b3</ContactKey>
  <CreatedOn>2025-03-12T07:22:45.331352-04:00</CreatedOn>
  <DocumentKey>be28b35e-5db7-4972-8011-bb4ee7a30ec7</DocumentKey>
</DocumentFavorite>