POST api/v1.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": "42a37338-764a-4a86-b52a-3510bec37b8c", "DocumentKey": "eaf52831-0dae-49aa-ae6c-7f8f118fa506", "CreatedOn": "2025-07-22T12:27:15.1558217Z" }
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>42a37338-764a-4a86-b52a-3510bec37b8c</ContactKey> <CreatedOn>2025-07-22T08:27:15.1558217-04:00</CreatedOn> <DocumentKey>eaf52831-0dae-49aa-ae6c-7f8f118fa506</DocumentKey> </DocumentFavorite>