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": "2362e8ca-e1ba-4910-94fa-5c98bc198df3",
  "DocumentKey": "3938b4ab-451e-4240-a89c-2f6d99ac9564",
  "CreatedOn": "2025-11-15T04:00:52.3590698Z"
}

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>2362e8ca-e1ba-4910-94fa-5c98bc198df3</ContactKey>
  <CreatedOn>2025-11-14T23:00:52.3590698-05:00</CreatedOn>
  <DocumentKey>3938b4ab-451e-4240-a89c-2f6d99ac9564</DocumentKey>
</DocumentFavorite>