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": "4bc27f03-3bff-4dda-8940-e4b92fbf1c4b",
"DocumentKey": "c5d7981a-d8b6-46bf-84de-b08f785a8284",
"CreatedOn": "2026-01-24T05:10:07.3279731Z"
}
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>4bc27f03-3bff-4dda-8940-e4b92fbf1c4b</ContactKey> <CreatedOn>2026-01-24T00:10:07.3279731-05:00</CreatedOn> <DocumentKey>c5d7981a-d8b6-46bf-84de-b08f785a8284</DocumentKey> </DocumentFavorite>