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": "b4e822a5-06a2-471d-ac71-8bbb850edbcd",
  "DocumentKey": "d5e0b210-c59c-4fea-bbfe-ede271559c7b",
  "CreatedOn": "2024-12-21T16:10:38.7501481Z"
}

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>b4e822a5-06a2-471d-ac71-8bbb850edbcd</ContactKey>
  <CreatedOn>2024-12-21T11:10:38.7501481-05:00</CreatedOn>
  <DocumentKey>d5e0b210-c59c-4fea-bbfe-ede271559c7b</DocumentKey>
</DocumentFavorite>