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": "ef7e197a-5435-46bd-b602-21b95bd19434",
  "DocumentKey": "19ff8c34-b88b-4b0c-b29c-66d37263b3c7",
  "CreatedOn": "2025-06-27T06:05:40.2806626Z"
}

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>ef7e197a-5435-46bd-b602-21b95bd19434</ContactKey>
  <CreatedOn>2025-06-27T02:05:40.2806626-04:00</CreatedOn>
  <DocumentKey>19ff8c34-b88b-4b0c-b29c-66d37263b3c7</DocumentKey>
</DocumentFavorite>