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": "a75693f5-eb34-4d7d-998e-ed6d5e6187e2",
"DocumentKey": "64b25b18-6fb2-46ff-8988-b73b18b224af",
"CreatedOn": "2026-11-18T01:23:53.4204293Z"
}
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>a75693f5-eb34-4d7d-998e-ed6d5e6187e2</ContactKey> <CreatedOn>2026-11-17T20:23:53.4204293-05:00</CreatedOn> <DocumentKey>64b25b18-6fb2-46ff-8988-b73b18b224af</DocumentKey> </DocumentFavorite>