POST api/v1.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": "4cf48e18-7efc-4de2-9e0d-4890447fc99d",
  "DocumentKey": "3ade817c-267b-4668-9c4f-630a3ab194e2",
  "CreatedOn": "2025-11-20T08:41:25.7032547Z"
}

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>4cf48e18-7efc-4de2-9e0d-4890447fc99d</ContactKey>
  <CreatedOn>2025-11-20T03:41:25.7032547-05:00</CreatedOn>
  <DocumentKey>3ade817c-267b-4668-9c4f-630a3ab194e2</DocumentKey>
</DocumentFavorite>