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": "5762ac8f-bfb1-415a-9c25-761fe4255741",
  "DocumentKey": "17e0bdcf-c384-468b-974c-0eeed68bd853",
  "CreatedOn": "2025-02-05T02:20:37.5326736Z"
}

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>5762ac8f-bfb1-415a-9c25-761fe4255741</ContactKey>
  <CreatedOn>2025-02-04T21:20:37.5326736-05:00</CreatedOn>
  <DocumentKey>17e0bdcf-c384-468b-974c-0eeed68bd853</DocumentKey>
</DocumentFavorite>