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": "5871a98f-92de-4d58-ae0d-a663da4791a6",
  "DocumentKey": "69d08d2d-cc1a-453c-9d3a-542983c1cf6f",
  "CreatedOn": "2024-07-27T03:57:25.7283997Z"
}

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>5871a98f-92de-4d58-ae0d-a663da4791a6</ContactKey>
  <CreatedOn>2024-07-26T23:57:25.7283997-04:00</CreatedOn>
  <DocumentKey>69d08d2d-cc1a-453c-9d3a-542983c1cf6f</DocumentKey>
</DocumentFavorite>