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": "d4058b9b-9f64-49ca-83d2-2e07c6e6aad7",
"DocumentKey": "4ae19b05-7169-4eeb-beed-4b0ca6dad880",
"CreatedOn": "2026-11-20T01:08:09.0266521Z"
}
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>d4058b9b-9f64-49ca-83d2-2e07c6e6aad7</ContactKey> <CreatedOn>2026-11-19T20:08:09.0266521-05:00</CreatedOn> <DocumentKey>4ae19b05-7169-4eeb-beed-4b0ca6dad880</DocumentKey> </DocumentFavorite>