POST api/v1.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}

Add the specified Document to the Authenticated User's Favorite List.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentKey

DocumentKey of a Document.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

DocumentFavorite
NameDescriptionTypeAdditional information
ContactKey

globally unique identifier

None.
DocumentKey

globally unique identifier

None.
CreatedOn

date

None.

Response Formats

application/json, text/json

Sample: 
{
  "ContactKey": "e0d2a3d6-4b11-40ed-acd6-273e8e110c2d",
  "DocumentKey": "3d220da8-964a-4fd9-bf84-9fffc7b55b6b",
  "CreatedOn": "2026-04-13T17:25:10.8363695Z"
}

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>e0d2a3d6-4b11-40ed-acd6-273e8e110c2d</ContactKey>
  <CreatedOn>2026-04-13T13:25:10.8363695-04:00</CreatedOn>
  <DocumentKey>3d220da8-964a-4fd9-bf84-9fffc7b55b6b</DocumentKey>
</DocumentFavorite>