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": "7c8f1663-9d97-45a4-a2a4-2a5747f8b9ba",
  "DocumentKey": "b2c58d9d-3d8b-474a-b298-c60755c889cd",
  "CreatedOn": "2026-02-09T12:42:39.9468707Z"
}

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>7c8f1663-9d97-45a4-a2a4-2a5747f8b9ba</ContactKey>
  <CreatedOn>2026-02-09T07:42:39.9468707-05:00</CreatedOn>
  <DocumentKey>b2c58d9d-3d8b-474a-b298-c60755c889cd</DocumentKey>
</DocumentFavorite>