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": "7b05c8e4-3355-4d81-b031-df66d1af485d",
  "DocumentKey": "79960065-d01e-4fde-a666-0f6580e1c557",
  "CreatedOn": "2025-12-20T03:06:05.1369883Z"
}

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>7b05c8e4-3355-4d81-b031-df66d1af485d</ContactKey>
  <CreatedOn>2025-12-19T22:06:05.1369883-05:00</CreatedOn>
  <DocumentKey>79960065-d01e-4fde-a666-0f6580e1c557</DocumentKey>
</DocumentFavorite>