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": "1b9978cd-889b-4782-b30f-84e2339af95d",
  "DocumentKey": "9a31e8da-a27f-4bc5-8fd7-6c3ea05f3eb4",
  "CreatedOn": "2025-12-16T05:12:45.109296Z"
}

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>1b9978cd-889b-4782-b30f-84e2339af95d</ContactKey>
  <CreatedOn>2025-12-16T00:12:45.109296-05:00</CreatedOn>
  <DocumentKey>9a31e8da-a27f-4bc5-8fd7-6c3ea05f3eb4</DocumentKey>
</DocumentFavorite>