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": "7385f6aa-7f7d-43e6-b002-8dcb4dfe90a5",
"DocumentKey": "8f1a3ea6-7c31-49ae-8f95-0f29f5f67b72",
"CreatedOn": "2026-01-24T17:06:52.4764561Z"
}
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>7385f6aa-7f7d-43e6-b002-8dcb4dfe90a5</ContactKey> <CreatedOn>2026-01-24T12:06:52.4764561-05:00</CreatedOn> <DocumentKey>8f1a3ea6-7c31-49ae-8f95-0f29f5f67b72</DocumentKey> </DocumentFavorite>