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": "be324eb3-a9ce-4221-b875-bb99f99223ff",
  "DocumentKey": "097129c6-d1d0-4f19-9ff7-354d8586c05b",
  "CreatedOn": "2026-04-06T12:15:27.7245614Z"
}

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>be324eb3-a9ce-4221-b875-bb99f99223ff</ContactKey>
  <CreatedOn>2026-04-06T08:15:27.7245614-04:00</CreatedOn>
  <DocumentKey>097129c6-d1d0-4f19-9ff7-354d8586c05b</DocumentKey>
</DocumentFavorite>