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": "b3a6d919-3132-4074-a50a-833dad994ce5",
  "DocumentKey": "c231278d-8aac-4451-8b80-4334f390e0df",
  "CreatedOn": "2026-02-01T20:43:53.3327658Z"
}

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>b3a6d919-3132-4074-a50a-833dad994ce5</ContactKey>
  <CreatedOn>2026-02-01T15:43:53.3327658-05:00</CreatedOn>
  <DocumentKey>c231278d-8aac-4451-8b80-4334f390e0df</DocumentKey>
</DocumentFavorite>