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
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": "675036ec-e100-4692-bdad-4d5f02623323",
"DocumentKey": "a86a8596-9eaf-4763-abe2-aec76fc8ebb7",
"CreatedOn": "2026-02-22T12:29:35.2172949Z"
}
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>675036ec-e100-4692-bdad-4d5f02623323</ContactKey> <CreatedOn>2026-02-22T07:29:35.2172949-05:00</CreatedOn> <DocumentKey>a86a8596-9eaf-4763-abe2-aec76fc8ebb7</DocumentKey> </DocumentFavorite>