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
DocumentFavorite| Name | 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": "3ad8eefd-8fc1-4d79-8016-1d45d523c06c",
"DocumentKey": "c61e4ae8-3857-4256-a4b6-97c5e7527328",
"CreatedOn": "2026-05-03T19:19:01.6885506Z"
}
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>3ad8eefd-8fc1-4d79-8016-1d45d523c06c</ContactKey> <CreatedOn>2026-05-03T15:19:01.6885506-04:00</CreatedOn> <DocumentKey>c61e4ae8-3857-4256-a4b6-97c5e7527328</DocumentKey> </DocumentFavorite>