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": "ace1a671-9538-4ded-b1bd-0fa3dbcfd1b1",
  "DocumentKey": "a73b5230-504b-4b33-8b21-a898df28b336",
  "CreatedOn": "2026-05-01T14:25:30.3381708Z"
}

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>ace1a671-9538-4ded-b1bd-0fa3dbcfd1b1</ContactKey>
  <CreatedOn>2026-05-01T10:25:30.3381708-04:00</CreatedOn>
  <DocumentKey>a73b5230-504b-4b33-8b21-a898df28b336</DocumentKey>
</DocumentFavorite>