POST api/v2.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": "cb0db5b3-caaf-45a9-81ea-7493332ed884",
  "DocumentKey": "1f09aa81-0f1d-462f-949e-c89c15db9751",
  "CreatedOn": "2026-06-27T18:55:57.877425Z"
}

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>cb0db5b3-caaf-45a9-81ea-7493332ed884</ContactKey>
  <CreatedOn>2026-06-27T14:55:57.877425-04:00</CreatedOn>
  <DocumentKey>1f09aa81-0f1d-462f-949e-c89c15db9751</DocumentKey>
</DocumentFavorite>