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": "193d3593-b225-4869-bd20-34d4ba38635b",
  "DocumentKey": "9d867ef3-c704-4419-af77-3dae86f61188",
  "CreatedOn": "2024-05-23T22:48:09.2315435Z"
}

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>193d3593-b225-4869-bd20-34d4ba38635b</ContactKey>
  <CreatedOn>2024-05-23T18:48:09.2315435-04:00</CreatedOn>
  <DocumentKey>9d867ef3-c704-4419-af77-3dae86f61188</DocumentKey>
</DocumentFavorite>