POST api/v2.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}
Add the specified Document to the Authenticated User's Favorite List.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
documentKey |
DocumentKey of a Document. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
DocumentFavoriteName | Description | Type | Additional information |
---|---|---|---|
ContactKey | globally unique identifier |
None. |
|
DocumentKey | globally unique identifier |
None. |
|
CreatedOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{ "ContactKey": "8aab6eb2-ae11-4635-80d5-f079dcf23d66", "DocumentKey": "838c8b21-85af-40b6-860b-1f7a7f00dc44", "CreatedOn": "2025-09-18T04:05:50.0854204Z" }
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>8aab6eb2-ae11-4635-80d5-f079dcf23d66</ContactKey> <CreatedOn>2025-09-18T00:05:50.0854204-04:00</CreatedOn> <DocumentKey>838c8b21-85af-40b6-860b-1f7a7f00dc44</DocumentKey> </DocumentFavorite>