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": "99ef0cf1-be9c-4859-b89a-dd2b9d4a8dc1",
  "DocumentKey": "2f6f4fcb-e84f-4918-b54e-39e486360ff9",
  "CreatedOn": "2026-02-08T08:29:55.9031521Z"
}

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>99ef0cf1-be9c-4859-b89a-dd2b9d4a8dc1</ContactKey>
  <CreatedOn>2026-02-08T03:29:55.9031521-05:00</CreatedOn>
  <DocumentKey>2f6f4fcb-e84f-4918-b54e-39e486360ff9</DocumentKey>
</DocumentFavorite>