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": "78fe3e23-6431-4685-94bc-3533bee901e1",
  "DocumentKey": "bf959cc1-df55-4e96-9a3b-b6cd14f79218",
  "CreatedOn": "2026-01-04T05:00:14.9978086Z"
}

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>78fe3e23-6431-4685-94bc-3533bee901e1</ContactKey>
  <CreatedOn>2026-01-04T00:00:14.9978086-05:00</CreatedOn>
  <DocumentKey>bf959cc1-df55-4e96-9a3b-b6cd14f79218</DocumentKey>
</DocumentFavorite>