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": "c192cee8-9e3a-4d72-9cb2-345963924dd8",
  "DocumentKey": "3d16a0f7-aff0-4769-8139-d2b7df7d1fe9",
  "CreatedOn": "2025-12-01T11:12:32.9721269Z"
}

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>c192cee8-9e3a-4d72-9cb2-345963924dd8</ContactKey>
  <CreatedOn>2025-12-01T06:12:32.9721269-05:00</CreatedOn>
  <DocumentKey>3d16a0f7-aff0-4769-8139-d2b7df7d1fe9</DocumentKey>
</DocumentFavorite>