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": "8a420367-991c-4497-bfdc-66d572c3dda2",
"DocumentKey": "16b9321c-40b7-4eef-8bec-06f2bc646bd2",
"CreatedOn": "2026-05-04T21:16:03.6983203Z"
}
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>8a420367-991c-4497-bfdc-66d572c3dda2</ContactKey> <CreatedOn>2026-05-04T17:16:03.6983203-04:00</CreatedOn> <DocumentKey>16b9321c-40b7-4eef-8bec-06f2bc646bd2</DocumentKey> </DocumentFavorite>